Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Path Parameters

id
string
required

Agent id.

Minimum string length: 1

Query Parameters

locationId
string

Pair with campaignId; omit both for primary campaign.

Minimum string length: 1
campaignId
string

Pair with locationId; omit both for primary campaign.

Minimum string length: 1

Body

application/json
contactId
string | null

Existing GHL contact id for outbound/appointment campaign tests. The dashboard resolves this client-side. Use null for inbound dial-in tests.

Example:

"contact_123"

contact
object

API-convenience alternative to contactId: create — or reuse, deduped by phone — a GHL contact from these details when contactId is omitted. No marker tag is applied. contactId wins when both are sent.

callerPhone
string

Tester phone number for inbound dial-in tests.

Example:

"+14155559876"

agentTest
boolean

When true, run an agent-only inbound test without campaign side effects.

Example:

false

{key}
any

Response

Campaign test run created.

success
boolean
required
data
object
required