Docs

updateUser

Update a User object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PUT/v1/chat/users/{id}

Authorization

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

Header parameters

x-bot-idstringrequired
Bot id
x-integration-idstring
Integration id
x-integration-aliasstring
Integration alias

Path parameters

idstringrequired
User ID

Request body

User data

tagsobject
Tags for the User
namestring | null
Name of the user(max length: 200)
pictureUrlstring | null
URI of the user picture(max length: 40000)
attributesobjectdeprecated
DEPRECATED - Use properties instead.
propertiesobject
EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.

Response

application/json

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

The response is of type updateUserResponse · object.

userobjectrequired
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.