Inboxes

List automations

List automations. Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.

GET
/inboxes/{inbox_id}/automations

List automations.

Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.

Authorization

bearerToken
AuthorizationBearer <token>

Personal access tokens created from the ThriveDesk UI. Create one under Integrations -> API Keys.

In: header

Path Parameters

inbox_id*string

Inbox identifier.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/inboxes/string/automations"
{  "data": [    {      "id": "string",      "name": "string",      "automatic": true,      "active": true,      "when": {},      "rules": {},      "actions": [        {}      ],      "created_by": {        "id": "string",        "name": "string",        "first_name": "string",        "last_name": "string",        "email": "[email protected]",        "phone": "string",        "job_title": "string",        "avatar": "http://example.com",        "role": "Account Owner",        "presence": "online",        "timezone": "string",        "time_format": "string",        "active_organization_id": "string",        "created_at": "2019-08-24T14:15:22Z",        "extra": {          "password_reset_required": true,          "notification_preferences": {},          "firebase_notification_preferences": {},          "mobile_notification_preferences": {},          "auto_advance_ticket_enabled": true,          "undo_send_enabled": true,          "undo_send_delay": 0        }      },      "uses_count": 0,      "last_used_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Update a holiday PATCH

Administrators and the account owner only. When only one date is sent the range is checked against the stored value for the other. A range violation is always reported under `end_date`, even when `start_date` is the field that moved. Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.

Delete an automation DELETE

Requires the `delete_automations` permission. Permanent: the automation is removed outright, and conversations it already acted on keep those changes. Creating and updating automations is not part of this surface. Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.