Update a campaign automation
Enables/disables an automation or patches its config. Omitted fields keep their current value; config keys shallow-merge.
Enables/disables an automation or patches its config. Omitted fields keep their current value; config keys shallow-merge.
Authorization
bearerAuth campaigns:updateA gallery API key, sent as Authorization: Bearer gpk_… (or the x-api-key header).
In: header
Scope: campaigns:update
Path Parameters
The automation path segment.
Header Parameters
Optional. Send a unique key per logical operation to make retries safe: a retry with the same key replays the stored success for 14 days instead of re-running the write. Reusing a key with a different body returns 400.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Enable/disable an automation or patch its config. Omitted fields keep their current value.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
{ "automation": "new_work_alert", "enabled": true, "config": { "engaged_days": 1, "fair_lead_days": 3 }}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}{ "type": "../dictionary", "title": "string", "status": 0, "detail": "string", "code": "invalid_request", "retry": "permanent", "details": null}List campaign automations GET
Lists the relationship automation library: every automation with its enabled state and config. A gallery with no stored setting reads the library default.
Cancel a scheduled campaign POST
Moves a `scheduled` campaign back to `draft` (clearing its send time) so it can be edited. A campaign the worker has already claimed can't be canceled.