Deactivate Customer/Patient
  • 16 Jul 2025
  • 1 Minute to read
  • Dark
    Light

Deactivate Customer/Patient

  • Dark
    Light

Article summary

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.

Delete
/cdm/client/{client_id}/customer/{ccid}

This API deactivates a Customer or Patient Account, which include all notification channels associated with that Customer or Patient Account.

Header parameters
xx-relay-api-key
stringRequired

Contains the API key needed.

Path parameters
client_id
stringRequired

Client ID

Minimum1
ccid
stringRequired

Uniquely identifies a Customer or Patient.

Max length100
ExampleBAK-11984-007
Responses
200

OK - Customer or Patient was successfully deactivated.

object

Example message success details.

message
string
Max length100
ExampleCustomer {ccid} deactivated for client {client_id}
400

Invalid request

401

Unauthorized

404

Not Found - The requested resource was not found. Please verify the route parameter.

409

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.

500

An unexpected server error occurred. The response body should contain additional information related to the server error. Please retry your request.}


Was this article helpful?