curl -X POST "https://api.nedzo.ai/v1/workflows/123e4567-e89b-12d3-a456-426614174000/enroll" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "contactIds": ["523e4567-e89b-12d3-a456-426614174000"] }'
{
"enrolled": 1,
"skipped": 0,
"alreadyInWorkflow": 0
}
Workflows
Add contacts to a workflow
Start a run of a workflow for each contact you name.
POST
/
workflows
/
{id}
/
enroll
curl -X POST "https://api.nedzo.ai/v1/workflows/123e4567-e89b-12d3-a456-426614174000/enroll" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "contactIds": ["523e4567-e89b-12d3-a456-426614174000"] }'
{
"enrolled": 1,
"skipped": 0,
"alreadyInWorkflow": 0
}
This endpoint is for the VIP plan only. Other plans get a
403. See Plan access.202 when the runs are queued. The steps run after that. Each step that sends a message or makes a call checks DND for the contact when it runs.
We skip a contact that is not in this workspace, is deleted, or may not be processed. We skip a contact that is in a run of this workflow that has not finished.
Path Parameters
string
required
The workflow’s id.
Body
string[]
required
The contacts to add, 1 to 10,000.
curl -X POST "https://api.nedzo.ai/v1/workflows/123e4567-e89b-12d3-a456-426614174000/enroll" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "contactIds": ["523e4567-e89b-12d3-a456-426614174000"] }'
{
"enrolled": 1,
"skipped": 0,
"alreadyInWorkflow": 0
}
| Field | What it counts |
|---|---|
enrolled | Runs started. |
skipped | Contacts not in this workspace, deleted, or not allowed to be processed. |
alreadyInWorkflow | Contacts in a run of this workflow that has not finished. |
Errors
| Status | When |
|---|---|
400 | contactIds is empty or has more than 10,000 ids, or the workflow is not published, not on, has no steps, or has a step that turns DND off. |
402 | The account has no plan, or its subscription is not active. |
403 | Your plan is not VIP, workflows are not on your plan, or the workspace is locked. |
404 | No workflow has this id, or it is not in this key’s scope. |
Was this page helpful?