Sign in

v52

latestOpenAPI 3.0.1raw.githubusercontent.com2026-08-01353775.9 KB
Customer

put/v1/customer

Query parameters

subscriberCustomerIdstring

The subscriber customer id to match. All customers with this id will be updated.

externalUserIdstring

The messaging-platform user id (e.g. the WhatsApp BSUID) to match. All customers with this id will be updated.

Request body

firstNamestring

The first name of the customer

lastNamestring

The last name of the customer

emailstring email

The email of the customer

phoneNumberstring

The phone number of the customer (in international / E.164 format)

displayNamestring

The display name of the customer

remoteIdstring

The id of the customer in the ticketing system. For the SDK this needs to be stable and unique

subscriberCustomerIdstring

The id of the customer in your own primary database or a unique identifier, for example a cookie

subscriberTokenstring

A token that can be used to authenticate the customer in the your system, like a JWT

avatarUrlstring

The URL of the customer avatar

Example request

{
  "firstName": "Lori",
  "lastName": "Keet",
  "email": "lori@keet.com",
  "phoneNumber": "+14155552671",
  "displayName": "Lori Keet",
  "remoteId": "1234567890",
  "subscriberCustomerId": "1234567890",
  "avatarUrl": "https://example.com/image.jpg"
}

Response

Customers updated successfully

firstNamestring

The first name of the customer

lastNamestring

The last name of the customer

emailstring email

The email of the customer

phoneNumberstring

The phone number of the customer (in international / E.164 format)

displayNamestring

The display name of the customer

remoteIdstring

The id of the customer in the ticketing system. For the SDK this needs to be stable and unique

subscriberCustomerIdstring

The id of the customer in your own primary database or a unique identifier, for example a cookie

subscriberTokenstring

A token that can be used to authenticate the customer in the your system, like a JWT

avatarUrlstring

The URL of the customer avatar

idstring uuid required

The id of the customer in the subscriber system

externalUserIdstring

The messaging-platform user id of the customer (e.g. the WhatsApp BSUID). Not a phone number.

createdAtstring date-time required

The timestamp of the when the customer was created in our system

Example response

[
  {
    "firstName": "Lori",
    "lastName": "Keet",
    "email": "lori@keet.com",
    "phoneNumber": "+14155552671",
    "displayName": "Lori Keet",
    "remoteId": "1234567890",
    "subscriberCustomerId": "1234567890",
    "avatarUrl": "https://example.com/image.jpg",
    "id": "e63d04d0-cfd4-46ad-9186-20ee31a8563b",
    "externalUserId": "BR.1A2B3C4D5E6F7G8H9I0J1K2L3M4N5O6P7Q8R9S0T"
  }
]