The API allows you to delete data from multiple campaigns in your account.
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
Pass the body parameters in the below format.
{
"userName": "Your account User name", "phoneNumber": [ 1234567890, 1234567890, 1234565432, ][ 1234567890, 1234567890, 1234565432, ], "campaignName": [ "Campaign Name 1", "Campaign Name 2", "Campaign Name 3" ][ "Campaign Name 1", "Campaign Name 2", "Campaign Name 3" ] }
Content-Type should be 'application/json'
Rate Limit:
- A maximum of 2 requests are allowed per minute.
- New request will not be accepted until the current one gets processed.
- Up to 100 phone numbers or 100 campaign names can be processed per request.
- Data will be deleted regardless of the lead status.
- If even one campaign name is invalid, the API will throw an error.
Possible responses
Passing Invalid userName Key | "{""status"": ""false"",""message"": ""Username Should Not be Null or Empty."", ""data"": null}" |
Passing Invalid userName Value | {"status": "false","message": "Invalid User Details","data": null} |
Passing Invalid phoneNumber Key | "{ ""status"": ""Error"", ""message"": ""PhoneNumbers should not be null are empty"" }" |
Missing phoneNumber key | "{ ""status"": ""Error"", ""message"": ""PhoneNumbers should not be null are empty"" }" |
Passing Invalid campaignName Key | "{ ""status"": ""Error"", ""message"": ""Campaign should not be null are empty"" }" |
Missing campaignName key | "{ ""status"": ""Error"", ""message"": ""Campaign should not be null are empty"" }" |
Missing campaignName Value | "{ ""status"": ""Error"", ""message"": ""Passed campaign are invalid"" }" |
If hit more than 2 times in a minute. | { ""status"": ""Error"", ""message"": ""Max limit exceeded"" }" |
Passing more than 100 numbers | "{ ""status"": ""Error"", ""message"": ""A maximum of 100 phone numbers or 100 campaign names will be accepted"" }" |
Passing more than 100 CampaignNames. | "{ ""status"": ""Error"", ""message"": ""A maximum of 100 phone numbers or 100 campaign names will be accepted"" }" |