Create an embed user from an external user ID

Version 4.0.24.2 (latest)

Create an embed user from an external user ID

Calls to this endpoint require Embedding to be enabled

Request

POST /users/embed_user
Datatype
Description
Request
HTTP Request
body
HTTP Body
Expand HTTP Body definition...
Expand CreateEmbedUserRequest definition...
external_user_id
string

Response

200: Created embed user

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
first_name
string
First Name
last_name
string
Last Name
display_name
string
Full name for display (available only if both first_name and last_name are set)
avatar_url
string
URL for the avatar image (may be generic)
url
string
Link to get this item

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link