Approve or remove one person
`approve` hands this person's plan to the clock: the step they are standing on goes out in the sequence's sending hours, spaced by the account's limits, and every later step follows on schedule exactly as the plan was left. It does not send anything itself. `remove` takes them out of the sequence and nothing is ever sent. Keyed on the enrollment, so a second press finds it already dealt with and says so.
approve hands this person's plan to the clock: the step they are standing on goes out in the sequence's sending hours, spaced by the account's limits, and every later step follows on schedule exactly as the plan was left. It does not send anything itself. remove takes them out of the sequence and nothing is ever sent. Keyed on the enrollment, so a second press finds it already dealt with and says so.
API key (sk_live_... prefix). Generate keys in the UI under Settings > API Keys, then send it as Authorization: Bearer sk_live_...
In: header
Path Parameters
uuidRequest Body
application/json
"approve" | "remove"Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/org/outreach-queue/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "action": "approve" }'{
"data": {
"approved": true,
"removed": true
}
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "module_required",
"module": "string",
"message": "string",
"contact": "string"
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}{
"error": "string",
"message": "string",
"statusCode": -9007199254740991
}How many people are waiting to be reviewed GET
One number, for a badge. Answers 0 rather than 403 for an org without the sequencer, so a caller that asks on every page does not have to know whether the module is on.
List the organization's outreach sequences GET
Every sequence the org has drawn, newest first, with how many steps each one has and how many contacts are currently moving through it. Gated by the `sequencer` module; otherwise responds 403 module_required.