Update User

curl https://api.thanxsandbox.com/partner/users/:id?merchant_id=owierywtwt \
  -X PATCH \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "user": {
      "email": "john.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'

{
  "user": {
    "id": "wroeiu2304hfwf",
    "email": "john.smith@example.com",
    "phone": "+14158672345",
    "first_name": "Jane",
    "last_name": "Smith",
    "birth_date": {
      "year": 1987,
      "month": 8,
      "day": 14
    },
    "zip_code": "12345",
    "updated_at": "2025-02-01T19:00:00Z",
    "loyalty": {
      "tier": "silver",
      "points_balance": 120.50,
      "user_joined_at": "2023-12-01T19:00:00Z"
    },
    "communication_settings": {
      "marketing_general_email": true
    }
  }
}

PATCH

partner

users

:id

curl https://api.thanxsandbox.com/partner/users/:id?merchant_id=owierywtwt \
  -X PATCH \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "user": {
      "email": "john.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'

{
  "user": {
    "id": "wroeiu2304hfwf",
    "email": "john.smith@example.com",
    "phone": "+14158672345",
    "first_name": "Jane",
    "last_name": "Smith",
    "birth_date": {
      "year": 1987,
      "month": 8,
      "day": 14
    },
    "zip_code": "12345",
    "updated_at": "2025-02-01T19:00:00Z",
    "loyalty": {
      "tier": "silver",
      "points_balance": 120.50,
      "user_joined_at": "2023-12-01T19:00:00Z"
    },
    "communication_settings": {
      "marketing_general_email": true
    }
  }
}

Scope required: users.write

The user’s phone number is not gathered by Thanx with the permission to use it for marketing.

To update a user’s notification / email settings, use Update User’s Communication Settings instead. communication_settings is read-only on this endpoint.

Parameters

string

required

User ID

string

required

Merchant ID

Body

string

The user’s email

string

The user’s phone number in E.164 format, with the country code prefix (e.g. +14157582345). Phones submitted without the country code prefix are stored as-is — this endpoint does not normalize them — and will fail later phone-based lookups (such as Partner Auth Token) that depend on E.164 parsing.

string

The user’s first name

string

The user’s last name

hash

The user’s birthday information

Show birth_date

integer

deprecated

The user’s birth year

integer

The user’s birth month

integer

The user’s birth day

string

The user’s zip code

Response

string

The user's identifier

string

The user's email

string

The user's phone number, in E.164 format (eg. +14157582345)

string

The user's first name

string

The user's last name

hash

The user's birthday information

Show birth_date

integer

deprecated

The user's birth year

integer

The user's birth month

integer

The user's birth day

string

The user's zip code

datetime

Datetime the user record was last updated.

hash

Show loyalty

string

The user's current tier (bronze, silver, gold).

number

The user's current points balance

datetime

Datetime the user joined the program in ISO8601-format

hash

Show communication_settings

boolean

Settings for when a merchant sends general marketing email

curl https://api.thanxsandbox.com/partner/users/:id?merchant_id=owierywtwt \
  -X PATCH \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -d '{
    "user": {
      "email": "john.smith@example.com",
      "first_name": "Jane",
      "last_name": "Smith"
    }
  }'

{
  "user": {
    "id": "wroeiu2304hfwf",
    "email": "john.smith@example.com",
    "phone": "+14158672345",
    "first_name": "Jane",
    "last_name": "Smith",
    "birth_date": {
      "year": 1987,
      "month": 8,
      "day": 14
    },
    "zip_code": "12345",
    "updated_at": "2025-02-01T19:00:00Z",
    "loyalty": {
      "tier": "silver",
      "points_balance": 120.50,
      "user_joined_at": "2023-12-01T19:00:00Z"
    },
    "communication_settings": {
      "marketing_general_email": true
    }
  }
}

⌘I

Merchant & Partner API

Reference

Parameters

Body

Response

​Parameters

​Body

​Response

Parameters

Body

Response