Bot Users
Create Bot User
Create a new bot user
Request
POST /bot_users
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
Response
Returns a 201 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique API key resource identifier |
uri | string | URI to the API resource of this bot user |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
created_at | string | timestamp when the api key was created, RFC 3339 format |
Delete Bot User
Delete a bot user by ID
Request
DELETE /bot_users/{id}
Example Request
Loading…
Response
Returns a 204 response with no body on success
Get Bot User
Get the details of a Bot User by ID.
Request
GET /bot_users/{id}
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique API key resource identifier |
uri | string | URI to the API resource of this bot user |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
created_at | string | timestamp when the api key was created, RFC 3339 format |
List Bot Users
List all bot users in this account.
Request
GET /bot_users
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
bot_users | BotUser | the list of all bot users on this account |
uri | string | URI of the bot users list API resource |
next_page_uri | string | URI of the next page, or null if there is no next page |
BotUser fields
| Name | Type | Description |
|---|---|---|
id | string | unique API key resource identifier |
uri | string | URI to the API resource of this bot user |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
created_at | string | timestamp when the api key was created, RFC 3339 format |
Update Bot User
Update attributes of a bot user by ID.
Request
PATCH /bot_users/{id}
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
id | string | unique API key resource identifier |
uri | string | URI to the API resource of this bot user |
name | string | human-readable name used to identify the bot |
active | boolean | whether or not the bot is active |
created_at | string | timestamp when the api key was created, RFC 3339 format |