Delete an Agent

The Delete an Agent API allows you to remove a registered agent profile from the RCS messaging platform based on agent number. Deleting an agent profile will impact any RCS messaging associated with that agent.

API request to delete an Agent

To delete an agent, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/agent/{agent_number} endpoint with the following request method:

The following is the request format to delete an agent:

curl --location --request DELETE 'https://<api_domain>/v1/<sid>/rcs/agent/{agent_number}'\
--header 'Content-Type: <content_type>' \
--header 'api-key: <api-key>'

The following is the sample request format to delete an agent:

curl --location --request DELETE 'https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/agent/48400'\
--header 'Content-Type: application/json' \
--header 'api-key: XXXXX3b8497f58a94e84b671aca43XXXX' 

The following is the list of parameters to be used in the payload to delete an agent by agent number:

Sample Success Response

The following is the sample success response:

{
    "code": "RCS902",
    "message": "Agent deleted succesfully",
    "data": {
        "status": "OK",
        "message": "Agent deleted",
        "message_key": "message"
    },
    "error": {}
}

Failure Responses

The following is the list of error codes that you can encounter while deleting an agent: