Exit API

This endpoint is used to off board /exit the receiver number from the given campaign based on the campaign id.

POSThttps://enterprise-webhooks-noneu.truecaller.com/v2/campaigns/exit

Headers

Name	Value
X-Org-ID	Required Organisation Id
X-Org-Token	Required Organisation Token

Body

{
    "data": [
        {
            "campaign_id": "Sale123",
            "receiver_numbers": [
                "91**********"
            ]
        }
    ]
}

{
    "data": [
        {
            "campaign_id": "Sale123",
            "receiver_numbers": [
                "cef02738f3229779cc5840c1a686771dfcd440dc7c7e177f95b5fe9c552b58b2"
            ]
        }
    ]
}

Name	Type	Validations	Description
data	array	min:1 max: 10	A collection of exit requests. Each object in this array defines which users should be removed from which specific campaign.
campaign_id	string	min:1 max: 500	This can be taken from the self serve portal under the Campaigns tab
receiver_number	array	min:1 max: 1000	Receiver Number, A list of phone numbers (with country codes, e.g., 91...) that should be offboarded or "exited" from the associated campaign. Also we can pass the number in the SHA256 format. It is best to pass the receiver numbers in same format that was used while linking/mapping it with campaigns.

Response

202 Accepted

{
    "message": "Payload received successfully for processing"
}

401 Unauthorized

{
    "slug": "authorization-error"
}

400 Bad Request

{
    "slug": "Cannot parse the request"
}