Add users (Bulk)

This API allows batch user addition. Each batch can include up to 1000 records and a rate limit of 120 requests per minute. For a smoother experience, it is strongly advised not to utilize the Bulk API for adding individual users

Query Parameters
bot string — REQUIRED The unique ID of the bot associated with the users.
uponConflict string Possible values: [UPDATE_EXISTING, RETAIN_IMPORTED] Specify the conflict resolution strategy when a userId is already present in the system. Update the existing user data with the provided information, or if the userId exists, retain the existing user data and ignore the import data.

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.
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 the user to your email notifications, else pass false.
smsOptin boolean Subscription status of the user to SMS. Pass true to subscribe the user to your SMS notifications, 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 Empty message string. data string — OPTIONAL Unique ID for the bulk creation of users.
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