Skip to main content
POST
Create Campaign

Headers

x-anyreach-org
string | null

Organization ID for user PATs (pat_ prefix tokens)

Body

application/json
name
string
required
external_id
string | null
configuration_id
string<uuid> | null
agent_number
string | null
priority
integer
default:1
Required range: 0 <= x <= 999999
agent_id
string<uuid> | null
version
integer | null
contacts
ContactInput · object[] | null
Maximum array length: 5000

Response

Successful Response

id
string<uuid>
required
organization_id
string
required
name
string
required
status
string
required
configuration_id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_id
string | null
agent_number
string
default:""
priority
integer
default:1
Required range: 0 <= x <= 999999
agent_id
string<uuid> | null
version
integer | null
created_by
string | null
modified_by
string | null
closed_at
string<date-time> | null