Add a phone number to a lead campaign

This API allows you to add a phone number to an existing WhatsApp campaign. If there is a lead existing by the given phone number, the same will be used. Else a new lead will be created.

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.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

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

{ "_data": { "process": { "id": "23a743bb-4671-440d-b491-3cac40eab852", "createdAt": 1765790485977, "updatedAt": 1769759079777, "status": "OPEN", "data": { "reference_number": "CHQ-005819", "customer_name": "John", "phone_number_int": "+919901258433", "lead_id": "LEAD-005788" }, "derivedData": { "lead_score": 50, "credit_score": 550, "lead_priority": "P2", "calc_date_time": 1765794086177, "csvector1": "e8686f08-1eb0-46a3-87f2-71f2ae760a2c" }, "meta": null, "nextActionAt": null, "completedAt": null, "cancelledAt": null, "firstAssignedAt": 1765790486660, "lastAssignedAt": 1765790486660, "isDeleted": false, "team": "5fc9f8e3-af4a-4f29-bfd8-6c02e3abe3ee", "procedure": "1ebb5952-f2d2-4c2f-9a00-832d669ede59", "createdBy": "5bc39b1d-5aa7-48a3-9436-51c103a18a3b", "assignedTo": "b4163247-6822-431f-8926-8c80ae5ad8e0", "belongsTo": null, "entity": "12a8bb04-0223-4a7e-9562-0c376acf0943", "record": null, "state": "bc903344-6ed3-468a-9929-d6485d22b244", "primaryBooking": null, "parentProcedure": null, "parentProcess": null, "firstAssignedTo": "b4163247-6822-431f-8926-8c80ae5ad8e0", "origin": null, "originId": null, "originRunId": null, "lastEmailMessage": null, "lastEmailMessageAt": null, "searchVector": "'919901258433' '9901258433' 'chq-005819' 'john' 'lead-005788'", "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": 1765790485977, "timeSpentInState": null, "processTemplate": null, "lastChatMessage": "32749386-1c8b-47f4-907f-f6f5a434dd48", "lastChatMessageAt": 1766474902680, "lastChatMessageDirection": "OUTBOUND", "autoDial": { "nextStepAt": 1765808487015, "currentStepId": "wait-1uQ1AZsysNJi4V4Mb4G8VD", "campaignEndedAt": null, "isQueuedForCall": false, "autoDialCampaignId": "232ccb90-8439-4556-9eb5-8b2bfde8bfcf" }, "deDuplication": null, "tags": [ "7044e6d6-70ac-4b9a-b419-ec7bbc121ef2" ], "contacts": null, "contactLabels": null, "visitor": null, "campaignStatus": null, "marketingStatus": null }, "wasCreated": false } }

Add a phone number to a lead campaign

Request

Responses