Add a lead

POST

https://api.hmsovereign.com/api/v1/campaigns/{id}/leads

Campaigns

Last modified:2026-01-30 13:43:45

Maintainer:Jesper Rietbergen

Add a new lead to a campaign.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Lead added

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.hmsovereign.com/api/v1/campaigns//leads' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "phone_number": "+31612345678",
    "variables": {
        "name": "John",
        "company": "Acme"
    }
}'

Response Example

{
    "lead": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "campaign_id": "78614b6c-fe7c-41e2-8e25-c9b3a3c91904",
        "phone_number": "+31612345678",
        "variables": {
            "name": "John",
            "company": "Acme Corp"
        },
        "status": "pending",
        "call_id": "0d0a16ab-a508-4d58-bf24-5dc3cb248f3e",
        "attempts": 0,
        "last_attempt_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-01-30 13:43:45

List campaign leads

Remove a lead