Start a campaign

POST /v1/campaigns/{campaign_id}/start

Start dialling a draft now, in its calling hours. Checked first: a campaign that cannot place a single call is refused here, not left running. Starting one that is running answers it as it is. 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 has finished, or cannot place a call yet: the agent is not published, it has no number to call from, or contacts lack a value the agent says out loud.
`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

Start a campaign

#!/bin/sh
# Start a campaign
curl -sS --fail-with-body -X POST "https://api.aigently.ai/v1/campaigns/1c3e5a7b-9d0f-4b2c-8e4a-6c8e0a2c4e6b/start" \
  -H "Authorization: Bearer $AIGENTLY_API_KEY"

Try it

Sends this request to the API from your browser, with a test key. Nothing it does rings a phone.