Board

Create an automation

Creates an Automation on the board (the board's workflows). Requires update permission and the key's "Automations" access (a separate toggle on the key, off by default, independent of "Edit Boards"); a key's board allowlist applies.

Always created paused. Nothing runs until the automation is switched on in the Aptly app, so the API can't set one live. Existing cards are not enrolled: once it is switched on a stage automation applies to cards that enter the stage afterwards.

Validated strictly - the request is refused outright on the first problem. Unknown properties, a stage / field / template / inbox / contact type / user / team that doesn't exist (or is archived) on this board or organization, an email template used for an SMS (or the reverse), an inbox of the wrong type or with no users, conditions that are empty, on a missing field, with an unsupported operator or a bad value, a delay with business hours, or a task or due-date action with business days, when none are configured, a webhook to anything but a public https address, and a pair of stage-moving automations that would send cards round in a circle are all rejected with 400. Shape problems come back as VALIDATION_ERROR with the offending path in meta.issues; problems found by checking against your data come back as INVALID_DATA with a message that names the path (for example actions[1].templateId: template "abc" was not found).

Supported triggers: stage, segment (conditions), reply. Supported actions: email, sms, task, assign, update_fields, stage, due_date, notify, archive, archive_convos, webhook. Task-completion and field-group triggers and the Yardi, e-sign, PDF, team-access and related-card actions aren't available through the API.

The response is the stored automation (the same shape GET .../automations returns).

post/api/board/{boardId}/configuration/automations

Request

Path parameters

boardIdstring required

The board's UUID.

Request body

titlestring required

Response

The created automation (paused).

Example response

{
  "data": {
    "archived": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.