Ctrlk
Get StartedStatus PagePartner Docs
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Users

Inbox Users

get

List the Users of your Inbox.

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Query parameters
include_assigned_wa_idsstringOptional

If true, includes the "assigned_wa_ids" field in the response.

is_availablebooleanOptional
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
200Success
application/json
countintegerRequiredExample: 123
nextstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=400&limit=100
previousstring · uri · nullableOptionalExample: http://api.example.org/accounts/?offset=200&limit=100
get/api/v1/users/
GET /api/v1/users/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "url": "https://example.com",
      "id": 1,
      "username": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "name@gmail.com",
      "profile": {
        "role": "user",
        "is_available": true
      },
      "groups": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "permissions": {
        "can_use_tags": true,
        "can_read_chats": "all",
        "can_write_to_chats": "all"
      },
      "assigned_wa_ids": [
        "text"
      ]
    }
  ]
}
post

Creates a new User. Only admin Users can create new Users.

IMPORTANT: Heads up! This request response returns an activation_url field, which is returned this way only once!

When you create a new User using this API, you need to call returned activation_url in order to activate newly created account.

Activating app Users

If you created a new User with role "app", calling the activation_url will result with a JSON response equal to Token Authorization request response, for example:

{"token": "8aeb44f5a318542d32bb13019d68198467ee21f0"}

You can then use this token with no need to set any password for this User.

Note that for "app" users, the activation code is no longer valid after the token is returned!

Activating regular and admin Users

When creating regular users, you might want to set password first and then activate the User afterwards. Use /users/{id}/password/change/ to set a password for this new User and then activate it.

If you integrate our API to an external system, you can integrate this URL so that users activate their accounts themselves either via email or any other solution you're using.

After activation URL is called, the account is ready to be used.

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Body
urlstring · uriRead-onlyRequired
activation_urlstring · uriRead-onlyRequired

Success! Your account is now created! Use this link to activate your account and set your password. You can open this link in any way while using this API. See this endpoint description to learn more on how activation URL works.

activation_email_sentbooleanRead-onlyRequired

Whether an invitation carrying the activation_url was e-mailed to the address in the email field.

It is false when no address was given, when the User has the "app" role (their activation link answers with an API token, which is not sent by e-mail), when activation e-mails are switched off for this inbox, or when the delivery failed. The account is created either way, so hand the activation_url over yourself when this is false.

idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailOptional
Responses
201Success
application/json
urlstring · uriRead-onlyRequired
activation_urlstring · uriRead-onlyRequired

Success! Your account is now created! Use this link to activate your account and set your password. You can open this link in any way while using this API. See this endpoint description to learn more on how activation URL works.

activation_email_sentbooleanRead-onlyRequired

Whether an invitation carrying the activation_url was e-mailed to the address in the email field.

It is false when no address was given, when the User has the "app" role (their activation link answers with an API token, which is not sent by e-mail), when activation e-mails are switched off for this inbox, or when the delivery failed. The account is created either way, so hand the activation_url over yourself when this is false.

idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailOptional
post/api/v1/users/
POST /api/v1/users/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 129

{
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  }
}
201Success
{
  "url": "https://example.com",
  "activation_url": "https://example.com",
  "activation_email_sent": true,
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  }
}
put

Change password of somebody else (only available for admins)

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters
idstringRequired
Body
passwordstringWrite-onlyRequired
Responses
200Success
application/json
passwordstringWrite-onlyRequired
put/api/v1/users/{id}/password/change/
PUT /api/v1/users/{id}/password/change/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}
200Success
{}
get

Get a single User.

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters
idintegerRequired

A unique integer value identifying this user.

Responses
200Success
application/json
urlstring · uriRead-onlyRequired
idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailRequired

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyRequired
get/api/v1/users/{id}/
GET /api/v1/users/{id}/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Accept: */*
200Success
{
  "url": "https://example.com",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  },
  "assigned_wa_ids": [
    "text"
  ]
}
put

Update user data - all fields are required. Only admin Users can update all fields of other Users. Regular Users can update only the following fields, and only of their own User object: "username", "first_name", "last_name", "email".

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters
idintegerRequired

A unique integer value identifying this user.

Body
urlstring · uriRead-onlyRequired
idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailRequired

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyRequired
Responses
200Success
application/json
urlstring · uriRead-onlyRequired
idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailRequired

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyRequired
put/api/v1/users/{id}/
PUT /api/v1/users/{id}/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "group_ids": [
    1
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  }
}
200Success
{
  "url": "https://example.com",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  },
  "assigned_wa_ids": [
    "text"
  ]
}
patch

Partially update user data - all fields are optional. Only admin Users can update all fields of other Users. Regular Users can update only the following fields, and only of their own User object: "username", "first_name", "last_name", "email".

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters
idintegerRequired

A unique integer value identifying this user.

Body
urlstring · uriRead-onlyOptional
idintegerRead-onlyOptional
usernamestringOptional

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailOptional

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyOptional
Responses
200Success
application/json
urlstring · uriRead-onlyRequired
idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailRequired

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyRequired
patch/api/v1/users/{id}/
PATCH /api/v1/users/{id}/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "group_ids": [
    1
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  }
}
200Success
{
  "url": "https://example.com",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  },
  "assigned_wa_ids": [
    "text"
  ]
}
patch

Allows users to set their 'is_available' status.

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Path parameters
idintegerRequired

A unique integer value identifying this user.

Body
is_availablebooleanOptional

Manual status set by the user to indicate availability for communication.

Responses
200Success
application/json
is_availablebooleanOptional

Manual status set by the user to indicate availability for communication.

patch/api/v1/users/{id}/availability/
PATCH /api/v1/users/{id}/availability/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "is_available": true
}
200Success
{
  "is_available": true
}
get

Get object of currently logged in User

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Responses
200Success
application/json
urlstring · uriRead-onlyRequired
idintegerRead-onlyRequired
usernamestringRequired

Username that is used in combination with password during login.

Only alphanumeric characters are allowed (A-Z, a-z, 0-9).

first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · emailRequired

E-mail address of this new user.

group_idsinteger[]Write-onlyOptional

List of group IDs to assign to the user (write-only)

assigned_wa_idsstring[]Read-onlyRequired
get/api/v1/users/current/
GET /api/v1/users/current/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Accept: */*
200Success
{
  "url": "https://example.com",
  "id": 1,
  "username": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "name@gmail.com",
  "profile": {
    "role": "user",
    "is_available": true
  },
  "groups": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "permissions": {
    "can_use_tags": true,
    "can_read_chats": "all",
    "can_write_to_chats": "all"
  },
  "assigned_wa_ids": [
    "text"
  ]
}
put

Change your password (currently logged in User)

Authorizations
AuthorizationstringRequired

A user token, sent as Token <token>. Create a user in the admin panel (group App integration) and get its token from POST /api/v1/auth/token/. The channel API key (D360-Api-Key) is not supported.

Body
current_passwordstringWrite-onlyRequired

Provide current password for security

new_passwordstringWrite-onlyRequired

Provide a new password that will be set to your account now

Responses
200Success
application/json
current_passwordstringWrite-onlyRequired

Provide current password for security

new_passwordstringWrite-onlyRequired

Provide a new password that will be set to your account now

put/api/v1/users/password/change/
PUT /api/v1/users/password/change/ HTTP/1.1
Host: your-stack.inbox.getchat.360dialog.io/
Authorization: Token YOUR_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "current_password": "text",
  "new_password": "text"
}
200Success
{}
PreviousMedia Files
NextGroups

Last updated

Was this helpful?