Sign in
Subscribers

Start a subscriber operation

Requires subscribers:read. Tagging and cancelling a tagging task also require subscribers:tag; creating tag definitions requires tags:write; triggering automations requires automations:trigger. Personal keys retain current company role restrictions. Company keys retain company-scoped authority. Workers recheck authority on every page. Returns immediately with a durable ID. Retry the same requestKey after an uncertain response. Active tasks have a seven-day processing deadline. Completed/failed/cancelled records are retained seven days. Inspect failures before retrying interrupted tagging; an uncertain action is never automatically replayed.

post/subscribers/operations

Request body

kind'add_tags' required
requestKeystring required

Reuse after an uncertain response. Different normalized settings with the same company/key return 409.

tagsstring[] required

Tag names, normalized like single-contact tags.

triggerAutomationsboolean

Requires automations:trigger.

Example request

{
  "audience": {
    "filters": [
      {
        "id": "filter-1"
      }
    ],
    "root": {
      "id": "root",
      "children": [
        {
          "id": "filter-1"
        }
      ]
    }
  }
}

Response

Operation accepted or existing operation replayed

successboolean required

Changes

Changed in 2 of the 135 revisions of this API.2