CAcarecycle
Sandbox

Initiate a sandbox outbound test call

post/v2/sandbox/calls

Request

  • Base URL
    https://api.carecycle.ai
  • URL
    https://api.carecycle.ai/v2/sandbox/calls
  • Auth
    API key in header x-api-key

Request body

campaignIdstring uuid required
assistantIdstring required
phoneNumberstring

E.164 phone number to call. Auto-resolved from your registered test number if omitted.

clientIdstring uuid

Target client organization ID. Super admin only; omit to use your own organization.

customerDataobject

Customer profile and policy fields to set on the test customer before calling. Accepts any clientCustomer field (firstName, lastName, postalCode, timezone, dateOfBirth, state, etc.) and policy fields (carrierName, planName, planCode, effectiveDate, enrollmentDate). Protected fields (id, clientId, callerId) are ignored.

Response

POST /v2/sandbox/calls Positive response

callIdstring uuid required
testCustomerIdstring uuid required
status'initiated' | 'missing_variables' required
missingVarsstring[]
availableVarsobject
requiredVarsstring[]

Changes

No recorded changes to this operation across all 2 revisions of this API.