Create a user

POST {{baseUrl}}/v3/users

Create a user

Creates a new user in the application. A user is identified by its unique user ID, and additionally have a changeable nickname, profile image, and so on.

https://sendbird.com/docs/chat/v3/platform-api/guides/user#2-create-a-user

Request Body

{"user_id"=>"<string>", "nickname"=>"<string>", "profile_url"=>"<string>", "profile_file"=>"<binary>", "issue_access_token"=>"<boolean>", "discovery_keys"=>["<string>", "<string>"], "metadata"=>"<object>"}

HEADERS

KeyDatatypeRequiredDescription
Api-Tokenstring(Required)
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;require_auth_for_profile_image&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_online&quot;:&quot;\u003cboolean\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;access_token&quot;:&quot;\u003cstring\u003e&quot;,&quot;has_ever_logged_in&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_active&quot;:&quot;\u003cboolean\u003e&quot;,&quot;last_seen_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;nickname&quot;:&quot;\u003cstring\u003e&quot;,&quot;discovery_keys&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;session_tokens&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;preferred_languages&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;profile_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;created_at&quot;:&quot;\u003cinteger\u003e&quot;,&quot;phone_number&quot;:&quot;\u003cstring\u003e&quot;,&quot;local&quot;:&quot;\u003cstring\u003e&quot;,&quot;locale&quot;:&quot;\u003cstring\u003e&quot;,&quot;is_hide_me_from_friends&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_shadow_blocked&quot;:&quot;\u003cboolean\u003e&quot;,&quot;is_created&quot;:&quot;\u003cboolean\u003e&quot;,&quot;metadata&quot;:{&quot;constructor&quot;:{&quot;arguments&quot;:{},&quot;caller&quot;:{&quot;value&quot;:&quot;\u003cCircular reference to #/components/schemas/Function detected\u003e&quot;},&quot;length&quot;:&quot;\u003cnumber\u003e&quot;,&quot;prototype&quot;:{}}},&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;end_at&quot;:&quot;\u003cnumber\u003e&quot;,&quot;start_at&quot;:&quot;\u003cnumber\u003e&quot;}