Create Subscriber

curl https://api.thanxsandbox.com/partner/subscribers/ \
  -X POST \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "merchant_id": "owierywtwt",
    "subscriber": {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name":  "Smith",
      "birth_date": {
        "month": 8,
        "day": 14
      },
      "zip_code": "12345"
    }
  }'

{
  "subscriber": {
    "email": "jane.smith@example.com"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Email does not appear to be valid"
  }
}

POST

partner

subscribers

curl https://api.thanxsandbox.com/partner/subscribers/ \
  -X POST \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "merchant_id": "owierywtwt",
    "subscriber": {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name":  "Smith",
      "birth_date": {
        "month": 8,
        "day": 14
      },
      "zip_code": "12345"
    }
  }'

{
  "subscriber": {
    "email": "jane.smith@example.com"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Email does not appear to be valid"
  }
}

Scope required: subscribers.write

This endpoint opts an email address into the specified merchant’s loyalty marketing. This will enable merchants to send targeted marketing to these subscribers in order to encourage loyalty opt-in. It is expected that all user information provided to Thanx via API must have gotten explicit user consent to participate in the merchant’s marketing. For integrations intending to sign up a user directly for a merchant’s loyalty program should be integrating with the Consumer APIs. This integration is more intensive, as it requires strict compliance with the legal requirements for user creation and must include a complete enrollment flow (prompt users for card linkage, display introductory incentives). Please reach out to our team at developer.support@thanx.com if you are interested in this type of integration instead. This endpoint only requires merchant_id and email to be specified, but accepts additional subscriber information. This endpoint responds with a 201 for any valid email address that is sent, even if the email address is already captured in the system. To avoid unintentional PII exposure for existing records in the system, this API responds only with accepted email address. The only time this endpoint 400s is when the input email address is invalid.

Body

string

required

Filter by Merchant ID

string

required

The subscriber’s email

string

The subscriber’s first name

string

The subscriber’s last name

hash

The subscriber’s birthday information

Show birth_date

integer

deprecated

The subscriber’s birth year

integer

The subscriber’s birth month

integer

The subscriber’s birth day

string

The subscriber’s zip code

curl https://api.thanxsandbox.com/partner/subscribers/ \
  -X POST \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "merchant_id": "owierywtwt",
    "subscriber": {
      "email": "jane.smith@example.com",
      "first_name": "Jane",
      "last_name":  "Smith",
      "birth_date": {
        "month": 8,
        "day": 14
      },
      "zip_code": "12345"
    }
  }'

Response

Subscriber

The newly created subscriber

Show Subscriber

string

The subscriber’s email

{
  "subscriber": {
    "email": "jane.smith@example.com"
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Email does not appear to be valid"
  }
}

Get Locations Get Users

⌘I

Merchant & Partner API

Reference

Create Subscriber

Body

Response

​Body

​Response

Body

Response