Remove phone number from a lead campaign

POST

/v1/ext/procedure/lead/remove-phone-number-from-campaign

This API allows you to remove a phone number to an existing WhatsApp campaign.

You will need to provide the campaign id as part of the body to use this API. See the gif below to understand how to get the campaign id from a campaign details page. Click on the 3 dots next to the save button and select the "Copy Campaign Id" options.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1/ext/procedure/lead/remove-phone-number-from-campaign' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "campaignId": "5ba0e13a-ac26-4656-afdd-643ea0813137",
  "phoneNumber": "919901258433"
}'

Response Example

{
    "_data": {
        "process": {
            "id": "0cb506a6-4bb5-481e-bcb3-c0f0ef5d909a",
            "createdAt": 1753709924877,
            "updatedAt": 1775554282328,
            "status": "OPEN",
            "data": {
                "reference_number": "CHQ-005725",
                "customer_name": "John",
                "phone_number_int": "+919901258433",
                "lead_id": "LEAD-005694"
            },
            "derivedData": {
                "lead_score": 50,
                "credit_score": 550,
                "lead_priority": "P2",
                "calc_date_time": 1754293923375,
                "csvector1": "4366faa7-1ac2-4053-b95b-aaacc2fac1f4"
            },
            "meta": null,
            "nextActionAt": 1754292120000,
            "completedAt": null,
            "cancelledAt": null,
            "firstAssignedAt": 1753709925150,
            "lastAssignedAt": 1753709925150,
            "isDeleted": false,
            "team": "5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee",
            "procedure": "1ebb5952-f2d2-4c2f-9a00-832d669ede59",
            "createdBy": "5bc39b1d-5aa7-48a3-9436-51c103a18a3b",
            "assignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
            "belongsTo": null,
            "entity": null,
            "record": null,
            "state": "bc903344-6ed3-468a-9929-d6485d22b244",
            "primaryBooking": null,
            "parentProcedure": null,
            "parentProcess": null,
            "firstAssignedTo": "be4b8ed8-d6ec-415d-b8ed-133bd904f0ac",
            "origin": null,
            "originId": null,
            "originRunId": null,
            "lastEmailMessage": null,
            "lastEmailMessageAt": null,
            "searchVector": "'919901258433' '9901258433' 'chq-005725' 'john' 'lead-005694'",
            "primaryShipment": null,
            "primaryShipmentStatus": null,
            "primaryShipmentLastEventTs": null,
            "escalationLevel": null,
            "slaData": {},
            "nextSlaActionAt": null,
            "lastEmailMessageDirection": null,
            "kanbanOrder": null,
            "contact": null,
            "company": null,
            "previousAssignedTo": null,
            "previousAssignedAt": null,
            "skills": {
                "b748e827-254c-4c7d-a9ad-6684d3e15d15": "90b68711-9fc8-471c-84cf-dcc3cfafcd0f"
            },
            "stateChangedAt": 1754290323261,
            "timeSpentInState": {
                "53dffbdf-4799-4fa3-8539-2e24c40c34a0": 580398
            },
            "processTemplate": null,
            "lastChatMessage": "d60a62cf-7b6c-41a7-aa24-8d5289e78729",
            "lastChatMessageAt": 1758279804877,
            "lastChatMessageDirection": "OUTBOUND",
            "autoDial": {
                "nextStepAt": 1753772400000,
                "currentStepId": null,
                "campaignEndedAt": null,
                "isQueuedForCall": false,
                "autoDialCampaignId": "1e34aa6a-7d9e-4a99-9a29-efef8e054b05"
            },
            "deDuplication": null,
            "tags": [
                "8136dfed-d2f5-4900-9e5b-a46185005bd6",
                "bd635b0a-2b1b-447c-b103-3d1c8cd72cb3"
            ],
            "contacts": null,
            "contactLabels": null,
            "visitor": null,
            "campaignStatus": null,
            "marketingStatus": null,
            "marketingSource": null
        },
        "wasRemoved": true
    }
}

Modified at 2026-04-21 06:07:28

Add a phone number to a lead campaign

Create Connect Token