Create omnichannel user

post https://api.sendios.io/v3/project/{projectId}/omnichannel/user

API endpoint to create an omnichannel user.

арp_push_token is considered valid if it meets one of these two conditions:

The text consists of at least 64 characters in the lower case of the hexadecimal number system (0-9 and a-f) and does not contain other characters;
The text has 22 characters, followed by a colon, after which it may contain any number of characters.

📘
By default, the VIP parameter has the value “0” (non-payer).

📘
Unlike creating a user through the API endpoint Send system / trigger email, when creating a user through this API endpoint, you can directly add any parameters to the "fields" section to transmit user information that is unique to your product. It is important that the values of the same parameter are transmitted in the same format.

Path Params

project_id

int32

required

Project identifier.

Body Params

client_user_id

string

required

User identifier on the client's side;

name

string

User name (maximum 128 characters);

sms_phone

string

User phone number to send SMS;

string

User email address;

app_push_token

string

User device token (APNs / Firebase authorization tokens are supported). The token type is determined automatically, and the sending method is selected accordingly;

language

string

User language (2-character language code according to ISO 639-1) (for example: EN, FR, UK, RU);

country

string

User's country (2 or 3-character country code according to ISO 3166);

platform_id

string

0 – Unknown, 1 – Desktop, 2 – Mobile (Mobile Browser + Tablet), 3 – Android App, 4 – iOS App;

gender

string

User gender: m – male, f – female;

vip

boolean

User status: 1 – payer, 0 – non-payer;

age

int32

User age (range of values: from 0 to 150 years);

photo

string

Link to the user's photo (URL);

string

Auth key – key for automatic user authorization on the client side (maximum 255 characters);

registered_at

date

User registration date on the client side (if not specified, it will be filled in as the creation date in Sendios), format YYYY-MM-DD hh:mm:ss according to ISO 8601 (for example, 2023-04-25 12:55:38).

fields

object

Customer user fields. This parameter can be used to convey user information unique to your product.

Responses

Language

Credentials

Basic

base64


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.sendios.io/v3/project/projectId/omnichannel/user \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘By default, the VIP parameter has the value “0” (non-payer).

200200

400400

📘
By default, the VIP parameter has the value “0” (non-payer).