API DocumentationCampaigns

Add Prospects To Campaign

Add one or more prospects to a campaign's prospect list.

Args: campaign_id: The ID of the campaign to add prospects to data: List of prospect data to add

Returns: Success message and count of added prospects

POST
/v1/campaigns/{campaign_id}/prospects
AuthorizationBearer <token>

In: header

Path Parameters

campaign_idCampaign Id
prospectsProspects

Response Body

curl -X POST "https://api.voxxi.ai/v1/campaigns/0/prospects" \
  -H "Content-Type: application/json" \
  -d '{
    "prospects": [
      {
        "name": "string",
        "phone": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        }
      }
    ]
  }'
{
  "success": true,
  "message": "string",
  "added_count": 0
}
{
  "detail": "string"
}
{
  "detail": "string"
}
{
  "detail": "string"
}
{
  "detail": [
    {
      "type": "string",
      "loc": [
        "string"
      ],
      "msg": "string",
      "ctx": {}
    }
  ]
}
{
  "detail": "string"
}