API reference
Resume a campaign
POST /v1/campaigns/{campaign_id}/resume
Start a paused campaign dialling again. With reset_attempts, everybody not reached so far gets every try back. Checked like a start. Needs campaigns:write and a live key.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
campaign_id |
path | string (uuid) | Yes |
Answer
200 with Campaign.
Errors
Every error is a problem document with a stable code.
| Status | When |
|---|---|
401 |
The key is missing, mistyped, unknown, revoked or expired. |
403 |
A test key: a campaign rings real people. |
404 |
This key reaches no such campaign. |
409 |
The campaign is not in a state this applies to, or has finished. |
422 |
Validation Error |
429 |
Too many requests for this key or its organization; see Retry-After. |
500 |
Something went wrong on our side. Quote the request_id to support. |
501 |
This deployment does not place phone calls. |
Examples
#!/bin/sh
# Resume a campaign
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/campaigns/1c3e5a7b-9d0f-4b2c-8e4a-6c8e0a2c4e6b/resume" \
-H "Authorization: Bearer $AIGENTLY_API_KEY" \
--json '{
"reset_attempts": false
}'
Try it
Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.