Sign in

v7

latestOpenAPI 3.1.02026-08-08265556.0 KB
Campaigns

Add Targets

Add targets to a campaign

post/api/v1/campaigns/{campaign_id}/targets

Path parameters

campaign_idstring required

The ID of the campaign to add targets to.

The ID of the campaign to add targets to.

Request body

launchboolean

Whether to launch the targets immediately or only add them to the campaign

allow_duplicatesboolean

When set to True all targets with and external ID already contained in the campaign will be ignored

strictboolean

When set to False, targets that fail validation are still uploaded; targets with an invalid phone number are marked as INVALID_PHONE_NUMBER when the call is about to be executed

Example request

{
  "targets": [
    {
      "fallback_phone_number": "+19876543210",
      "input_data": {
        "appointment_date": "2026-04-01",
        "appointment_type": "Follow-up"
      },
      "patient": {
        "date_of_birth": "1990-01-15",
        "external_id": "PAT-001",
        "extra_data": {
          "address": "123 Main St, Anytown, USA"
        },
        "first_name": "John",
        "last_name": "Doe"
      },
      "phone_number": "+1234567890",
      "pre_call_data": {
        "patient_name": "John Doe"
      }
    }
  ]
}

Response

Successful Response

{"stackTrail":"paths:/api/v1/campaigns/{campaign_id}/targets:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}