Create a campaign

POSThttps://server.heyrik.com/api/v1/campaigns

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 7

Fields documented for this operation. See the request example for placement and structure.

agency_idstringRequired

Agent that makes the calls.

trunk_idstringRequired

Number to dial FROM (a phone-number id).

namestring

Label.

filemultipart file

CSV/XLSX of leads. Optional — leads can be pushed later.

phone_columnstring

Which column holds the number. Default "phone".

concurrencynumber

Calls in flight at once. Default 1.

schedule_atstring

ISO time to start automatically.

Response

Explore the example values. This is not a complete response schema.

dataobject

Explore 4 properties

idstring

Example "cmp_4a19"

namestring

Example "July outreach"

statusstring

Example "draft"

totalnumber

Example 250

Error reference

POST/campaigns

cURL

curl -X POST https://server.heyrik.com/api/v1/campaigns \
  -H "Authorization: Bearer $HEYRIK_API_KEY" \
  -F "name=July outreach" \
  -F "agency_id=agc_9f2a1c30" \
  -F "trunk_id=sip_45723ca5" \
  -F "phone_column=phone" \
  -F "file=@leads.csv"

Response example

JSON

{
  "data": { "id": "cmp_4a19", "name": "July outreach", "status": "draft", "total": 250 }
}

Illustrative examples · No live request is sent