User information

To enable KakaoTalk Alim Talk messaging or SMS, you must register users' phone numbers in their Sendbird user profiles first.

Note: Existing users can be updated in bulk via the Sendbird Dashboard under Business Messaging > User insights > Import users. Refer to our guide on importing user data.

Create a new user

For users that do not yet have a Sendbird ID, link the phone number during the creation with the following API call.

HTTP request

POST https://api-{application_id}.sendbird.com/v3/users

Request body

Properties

Required	Type	Description
user_id	string	Specifies a user's unique ID. Maximum length is 80 characters. * Do not use PII (Personally Identifiable Information) such as user email address, legal name, or phone number as it could jeopardize data security and privacy.
nickname	string	Specifies the user's nickname. Maximum length is 80 characters.
profile_url	string	Specifies the URL of the user's profile image. If left empty, no profile image is set for the user. Maximum length is 2,048 characters. If the profile_url property is specified, the profile_file property is not required.

Optional	Type	Description
phone_number	string	Specifies the user’s phone number with the country code. An example would be: +82010XXXXXXXX.
profile_file	string	Specifies the file of the user's profile image. An acceptable image is limited to a JPG, JPEG, or PNG file of up to 5 MB. When passing a file, you should send a multipart request. If the profile_file property is specified, the profile_url property is not required.

Request body

{
  "user_id": "user_id",
  "nick_name": "nickname",
  "profile_url": "profile_url",
  "phone_number": "phone_number"
}

Add a phone number to an existing user

Add a phone number to an existing Sendbird user profile using the following API call.

HTTP request

PUT https://api-{application_id}.sendbird.com/v3/users/{user_id}

Parameters

The following table lists the parameters that this action supports.

Required

Parameter	Type	Description
user_id	string	Specifies the user ID to update the phone number.

Request body

The following tables list the properties of an HTTP request that this action supports.

Required

Property	Type	Description
phone_number	string	Specifies the user’s phone number with the country code. An example would be: +82010XXXXXXXX.

Request body

{
  "phone_number": "phone_number"
}

On this page

Create a new user

HTTP request Request body

Add a phone number to an existing user

HTTP request Parameters Request body