- 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
Remove phone number
- Updated on 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
The API endpoint `/cdm/client//customer//remove phone/` is designed to remove a phone number from a Customer or Patient record. It requires specific header and path parameters, including an API key, client ID, a unique customer or patient identifier (ccid), and the phone number to be removed, which must be between 10 to 11 digits long. Upon successful execution, the phone number is deleted from the notification channels associated with the record. The API responds with a 200 status code for success, providing a message confirming the removal. Other potential responses include 400 for invalid requests, 401 for unauthorized access, 404 if the resource is not found, 409 for conflicts, and 500 for unexpected server errors. Each response type includes specific details to guide the user in troubleshooting any issues encountered during the request.
This API removes a phone number from a Customer or Patient.
Contains the API key needed.
Client ID
Uniquely identifies a Customer or Patient.
The phone number for a Customer or Patient.
On success (200), this API removes the phone number from the array of notification channels in the Customer or Patient record.
Request body for Remove Phone.
The source provided by the client of the channel. Defaults to an internal channel.
OK - The phone number was successfully removed from the Customer or Patient record.
Example message success details.
Invalid request
Unauthorized
Not Found - The requested resource was not found. Please verify the route parameter.
Conflict - Indicates the request could not be processed. A common reason is when attempting to create a new Journey object, but the ID already exists in the system.
An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.