- 16 Jul 2025
- 1 Minute to read
- Print
- DarkLight
Deactivate Customer/Patient
- Updated on 16 Jul 2025
- 1 Minute to read
- Print
- DarkLight
The API endpoint /cdm/client//customer/ is designed to deactivate a Customer or Patient Account, along with all associated notification channels. It requires specific header and path parameters, including an API key and a unique client ID, as well as a customer or patient identifier (ccid) with a maximum length of 100 characters. Successful deactivation returns a 200 OK response, confirming the account has been deactivated. Other possible responses include 400 for invalid requests, 401 for unauthorized access, 404 if the resource is not found, 409 for conflicts (such as duplicate IDs), and 500 for unexpected server errors, which will include additional information in the response body. Users are advised to verify parameters and retry requests in case of errors.
This API deactivates a Customer or Patient Account, which include all notification channels associated with that Customer or Patient Account.
Contains the API key needed.
Client ID
Uniquely identifies a Customer or Patient.
OK - Customer or Patient was successfully deactivated.
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.}