GEgetprosperapp
Campaigns

Add Targets

Changed on

Add targets to a campaign

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

Request

  • Base URL
    https://voice.getprosperapp.com (the document declares no server; this is the origin it was published from)
  • URL
    https://voice.getprosperapp.com/api/v1/campaigns/{campaign_id}/targets
  • Auth
    none declared

Path parameters

campaign_idstring required

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

call_immediatelyboolean

Only used together with launch. Dial these targets as soon as they are queued, on an already running agent, instead of on the next dispatch with a freshly started one. Best effort: the campaign's calling hours still apply, a call falls back to a freshly started agent when none is idle, and it has no effect on payor campaigns. Meant for a handful of calls someone is waiting on, such as a demo.

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_ehr_ids": {
        "patient_id": "EHR-PAT-001"
      }
    }
  ]
}

Response

Successful Response

unknown required

Changes