Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-bot-id
string
required

Bot id

x-integration-id
string

Integration id

x-integration-alias
string

Integration alias

Body

application/json

User data

tags
object
required

Tags for the User

integrationName
string
deprecated

[DEPRECATED] To create a User from within a bot, call an action of the integration instead.

Maximum string length: 200
name
string

Name of the user

Maximum string length: 200
pictureUrl
string

URI of the user picture

Maximum string length: 40000
discriminateByTags
string[]

Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.

Maximum string length: 500

Response

Returns a User object if a valid identifier was provided. Returns an Error otherwise

user
object
required

The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.