Skip to main content
POST
Set automatic offline

Authorizations

api_access_token
string
header
required

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

application/json
profile
object
required

Which membership to set, and whether automatic offline is on.

Response

Success

id
number

The numeric ID of the user.

access_token
string

The user's userApiKey. Treat it as a credential — anything holding it can do whatever this user can.

account_id
number

The account the response is scoped to.

available_name
string

What contacts see: the display name when one is set, otherwise the full name.

avatar_url
string

URL of an uploaded avatar. Empty when the user has not uploaded one.

confirmed
boolean

Whether the user has confirmed their email address.

display_name
string | null

The name shown to contacts instead of the full name. Null when unset.

message_signature
string | null

Appended to outgoing replies on inboxes with signatures enabled. Null when unset.

email
string

The user's email address, which is also their login.

hmac_identifier
string

Identifier used when computing identity verification hashes.

inviter_id
number | null

The user who invited this one. Null for the account creator.

name
string

The user's full name.

provider
string

How the user signs in — email for a password login.

pubsub_token
string

Token for the realtime channel this user subscribes to. Treat it as a credential.

role
enum<string>

The role in the account this response is scoped to.

Available options:
agent,
administrator
ui_settings
object

Dashboard preferences — sidebar state, chosen avatar, and similar.

uid
string

The unique identifier the auth provider knows the user by. The same as the email for a password login.

type
string | null

Set for non-human users such as agent bots. Null for a person.

custom_attributes
object

Available for users who are created through platform APIs and has custom attributes associated.

accounts
object[]

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.

thumbnail
string

Path or URL of the avatar shown in the dashboard.

illustration_avatar
boolean

Whether thumbnail is a generated illustration rather than an upload.