API reference
Automation rules
Rules that act when something happens.
GET/automation
List automation
Needs the permission automation:read.
curl -X GET https://crm.anibrosdesign.com/api/v1/automation \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 401 403 429
GET/automation/executions
Get executions (automations)
Needs the permission automation:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
limit | query | integer | at least 1. up to 200. default 50 |
cursor | query | string | up to 512 characters |
status | query | one of pending, running, completed, failed, skipped | |
leadId | query | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/automation/executions \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 429
GET/automation/executions/{id}
Get executions (automation)
Needs the permission automation:read.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X GET https://crm.anibrosdesign.com/api/v1/automation/executions/{id} \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 403 404 429
POST/automation/executions/{id}/retry
Retry (automations)
Needs the permission automation:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
id required | path | string (uuid) |
curl -X POST https://crm.anibrosdesign.com/api/v1/automation/executions/{id}/retry \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
202 400 401 402 403 404 429
POST/automation/{template}/enable
Enable (automations)
Needs the permission automation:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
template required | path | string | up to 80 characters |
curl -X POST https://crm.anibrosdesign.com/api/v1/automation/{template}/enable \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
POST/automation/{template}/pause
Pause (automations)
Needs the permission automation:manage.
| Parameter | In | Type | Notes |
|---|---|---|---|
template required | path | string | up to 80 characters |
curl -X POST https://crm.anibrosdesign.com/api/v1/automation/{template}/pause \
-H "Authorization: Bearer crm_live_xxxxxxxx"Responses:
200 400 401 402 403 404 429
Something missing or unclear? Tell us.