Delete a Callback Profile by ID

Kaleyra.io offers an API that enables you to delete a callback profile based on ID. Deleting a callback profile can impact the tasks associated with it. For example, in a scheduled campaign the callback will get terminated.

Base URL

<https://api.kaleyra.io>

To delete a callback profile, perform the following steps:

API request to delete callback profile

To delete a callback profile, use the /callback/profiles/<id> endpoint with the following request method:

Request Format

curl --location --request DELETE '<url>/v1/<sid>/callback/profiles/<id>' \
--header 'api-key: <api-key>' \
--data-raw ''

The following table describes the parameter used for deleting the callback profile:

Sample Request

The following is the sample request:

curl --location --request DELETE 'https://api.kaleyra.io/v1/HXXXXXXX071IN/callback/profiles/SG_bxxxxxxf-2xx4-4xx9-8xx7-fxxxxxxxxxxa' \
--header 'api-key: Axxxxxxxxxxxxxxxxxxxxxxxxxxxx3' \
--data-raw ''

Sample Success Response

The following is the sample success response for deleting the callback profile:

{
    "code": "RBC024",
    "message": "Profile deleted successfully",
    "data": {
        "profileId": "SG_bxxxxxxf-2xx4-4xx9-8xx7-fxxxxxxxxxxa"
    },
    "error": {},
    "status": 200
}

Sample Failure Response

The following is a sample failure response when the callback profile ID does not exist:

{
    "code": "RBC302",
    "message": "No profile exists with this id",
    "data": {},
    "error": [
        {
            "params": "No profile exists with id: SG_cxxxxxxf-2xx4-4xx9-8xx7-fxxxxxxxxxxa"
        }
    ],
    "status": 404
}

For more information about response codes and statuses for deleting callback profiles, see Response Codes and Statuses for Deleting Callback Profile by ID.