Set your availability
Sets availability for one account membership. Availability is per account, so account_id is required even when the user only belongs to one. This is the switch behind the Online/Busy/Offline control in the dashboard.
Authorizations
This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
Body
Which membership to set, and to what.
Response
Success
The numeric ID of the user.
The user's userApiKey. Treat it as a credential — anything holding it can do whatever this user can.
The account the response is scoped to.
What contacts see: the display name when one is set, otherwise the full name.
URL of an uploaded avatar. Empty when the user has not uploaded one.
Whether the user has confirmed their email address.
The name shown to contacts instead of the full name. Null when unset.
Appended to outgoing replies on inboxes with signatures enabled. Null when unset.
The user's email address, which is also their login.
Identifier used when computing identity verification hashes.
The user who invited this one. Null for the account creator.
The user's full name.
How the user signs in — email for a password login.
Token for the realtime channel this user subscribes to. Treat it as a credential.
The role in the account this response is scoped to.
agent, administrator Dashboard preferences — sidebar state, chosen avatar, and similar.
The unique identifier the auth provider knows the user by. The same as the email for a password login.
Set for non-human users such as agent bots. Null for a person.
Available for users who are created through platform APIs and has custom attributes associated.
Every account this user belongs to, with their role and availability in each. A user can be an administrator in one and an agent in another.
Path or URL of the avatar shown in the dashboard.
Whether thumbnail is a generated illustration rather than an upload.