Skip to content

Read Waiting Contact Counts

Tool name: get-automation-waiting-contact-counts

Reads how many contacts wait at each action of one automation right now, with the action ID, type and name, most contacts first; actions nobody waits at are omitted. The counts are an observation, not a completion receipt for a queued move. A newsletter or autoresponder ID is refused.

Input schema

automationIdinteger, >= 1required

ID of the automation; a newsletter or autoresponder ID is refused

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{ "automationId": 1, "accountId": null }

Output schema

automationIdintegerrequired
namestringrequired
waitingArray of objectsrequired

Only the actions at which at least one contact is waiting, most contacts first.

totalintegerrequired
Output example
{ "automationId": 0, "name": "string", "waiting": [ { "actionId": 0, "type": "string", "name": "string", "contacts": 0 } ], "total": 0 }