Campaigns

Update campaign leads

Changed on

Updates leads in the specified campaign. Each lead is identified by either phone_number or campaign_lead_id.

patch/api/v4/campaigns/{campaign_id}/leads

Request

  • Base URL
    https://{cluster_id}.voiso.com
  • Auth
    HTTP bearer

Path parameters

campaign_idinteger required
Example:1

The unique identifier of the campaign.

Request body

Example request

[
  {
    "phone_number": "15551234567",
    "campaign_lead_id": 48153,
    "name": "John Doe",
    "source": {
      "system": "my_crm",
      "url": "https://example.com/leads/123"
    },
    "priority": 10,
    "context_headers": {
      "X-Client-Order-Id": "1234",
      "X-Call-Context": "discount_promo_code"
    }
  }
]

Response

OK

Example response

{
  "leads_update": {
    "not_found_campaign_lead_ids": [
      48999
    ],
    "campaign_leads": [
      {
        "id": 48153,
        "phone_number": "15551234567"
      }
    ]
  }
}

Changes

    • info

      added the new optional request property /

    • info

      the request property / became optional

    • info

      added subschema #1 subschema #2 to the request property oneOf list

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status