Enroll contacts in a sequence
enroll_in_sequenceEnroll a SEGMENT of subscribed contacts in a drip sequence: those carrying the given tags, or every subscriber of that account if no tag is given. Contacts who unsubscribed are never enrolled, and a sequence always stops for anyone who unsubscribes. Call it first without confirm to get how many contacts would be enrolled; they start receiving its steps as soon as you call it with confirm: true, after the user agreed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Only contacts with these tags. Omit to enrol every subscriber. | |
| confirm | No | true ONLY after the user saw how many contacts will be enrolled and agreed. Without it nothing is sent: you get that number. | |
| sequenceId | Yes | ||
| idempotencyKey | No | Optional. A unique id for this action (16-128 chars: letters, digits, _ : . -). If you are unsure whether a call went through (timeout, network error), repeat it with the SAME idempotencyKey and the same arguments: you get the original result and nothing is done twice. |