The following table shows the list of properties in a customer resource.
Property name
Type
Description
id
int
The unique ID of the customer.
sendbirdId
string
The user ID of the customer which is either identical with the user_id in Sendbird Chat platform or integrated with the account in the social media but not identical.
channelType
string
A channel type that indicates which channel the customer comes from. Valid values are SENDBIRD, FACEBOOK_PAGE, TWITTER_USER, INSTAGRAM_USER, and WHATSAPP_USER.
project
int
The unique ID of a Desk project where the agent belongs. Desk projects have their own corresponding Sendbird application on a one-to-one basis.
createdAt
string
The date and time when the customer was created, in ISO 8601 format.
displayName
string
The name of the customer displayed in the Sendbird Dashboard. It is identical with the nickname in Sendbird Chat platform when the customer came from it.
photoThumbnailUrl
string
The URL of the customer's profile image.
customFields[]
array
An array of key-value custom fields that indicates additional information about the customer. This property can have up to 20 custom fields.
API endpoints are relative to the base URL allocated to your application. In this page, the /customers endpoint refers to https://desk-api-{application_id}.sendbird.com/platform/v1/customers.
Note: If you want to know your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.
It's recommended that the parameter values in API URLs be urlencoded, such as {customer_id}.
The following table lists the properties of an HTTP request that this action supports.
Required
Property name
Type
Description
customFields
JSON string
Specifies a JSON string of one or more key-value custom fields to add or update. The specified key must be registered as a custom field in Settings > Customer fields of your dashboard beforehand. The length of key and value is limited to 20 and 190 characters, respectively. New values are added for the keys without values, or they will be updated if the specified key already has its value. When entering URLs for the link data type, it's recommended to start the URL with http:// or https://.
{
"customFields": "{
\"gender\":\"female\", // Dropdown
\"age\": 27, // Integer
\"country\":\"South Korea\", // Text
\"order-list\":\"{\\\"url\\\":\\\"https://sendbird.com/customer_cindy\\\",\\\"text\\\":\\\"Customer info\\\"}\" // Link
}"
}