Add user

Creates a user record in User360. There is a rate limit is 2000 per minute.

Query Parameters
bot string — REQUIRED The unique ID of the bot associated with the user record.

Request Body
firstName string The first name of the user.
lastName string Last name of the user.
gender string Gender of the user.
country string Country of the user.
city string City of the user according to the user's address.
language string Preferred language of the user.
email email Email address of the user.
phone string Phone number of the user with country code.
lastChannel string Recent channel (set up on yellow.ai) where the user had an active session. You can update this property to cover touch-points/channels outside yellow.ai.
dob date Date of birth of the user.
emailOptin boolean Subscription status of the user to emails. Pass true to subscribe for emails, else pass false.
smsOptin boolean Subscription status of the user to SMS. Pass true to subscribe the user to SMS, else pass false.
whatsAppOptin boolean WhatsApp subscription status of the user. Pass true to subscribe the user to your WhatsApp notifications, else pass false.
tags string[] List of groups associated with the user. You can add tags to users manually.

Responses
200 OK Schema — OPTIONAL message string — OPTIONAL data object — OPTIONAL userId object — OPTIONAL value string — OPTIONAL propertyType string — OPTIONAL lastName object — OPTIONAL value string — OPTIONAL propertyType string — OPTIONAL phone object — OPTIONAL value string — OPTIONAL propertyType string — OPTIONAL tags object — OPTIONAL value string[] — OPTIONAL propertyType string — OPTIONAL country object — OPTIONAL value string — OPTIONAL propertyType string — OPTIONAL emailOptIn object — OPTIONAL value boolean — OPTIONAL propertyType string — OPTIONAL botId object — OPTIONAL Unique ID of the bot associated with the user value string — OPTIONAL id object — OPTIONAL Unique internal ID genetated for the user. value string — OPTIONAL updatedAt object — OPTIONAL The date and time of the last update to the user record in the ISO standard format value date-time — OPTIONAL propertyType string — OPTIONAL createdAt object — OPTIONAL The date and time of the record creation in ISO standard format value date-time — OPTIONAL propertyType string — OPTIONAL profileComplete object — OPTIONAL value string — OPTIONAL
400 Bad Request Schema — OPTIONAL error string — OPTIONAL Error details
401 Unauthorized request or invalid X-Auth-Token or botId
406 Not Acceptable
500 Internal Server Error Schema — OPTIONAL error string — OPTIONAL Error details