menu
Update an automation
Updates an automation. Automation fields are interdependent, so send the complete automation object rather than a sparse patch.
Endpoint
PATCH https://api.sendstreak.com/v2/accounts/{accountId}/automations/{automationId}
All v2 endpoints require a bearer token - see Authentication.
Path parameters
| Parameter | Type | Description |
|---|---|---|
accountId | string | The account the request is scoped to. |
automationId | string |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
_id | string | no | |
name | string | yes | Name of the automation, shown on the dashboard. |
templateId | string | yes | Id of the email template the automation sends. |
triggerEventSlug | string | no | Contact event that triggers the send - see the events endpoint. |
active | boolean | no | Whether the automation currently fires; inactive automations keep their configuration. |
Response
The updated automation.
{
"_id": "665f0a2b1c9d440012ab34cd",
"name": "Example name",
"templateId": "6650cc1d3e8a220013ef78ab",
"triggerEventSlug": "signup",
"active": false
}
Errors
| Status | Description |
|---|---|
400 | The request body or parameters failed validation. |
401 | Missing or invalid token, or the token is not authorized for this account/user. |
404 | The requested resource does not exist. |
See Errors and rate limits for what error responses look like.
Curl example
curl --location --request PATCH 'https://api.sendstreak.com/v2/accounts/YOUR_ACCOUNT_ID/automations/YOUR_AUTOMATION_ID' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"_id": "665f0a2b1c9d440012ab34cd",
"name": "Example name",
"templateId": "6650cc1d3e8a220013ef78ab",
"triggerEventSlug": "signup",
"active": false
}'