Move Customer/Patient
  • 19 Nov 2024
  • 1 Minute to read
  • Dark
    Light

Move Customer/Patient

  • Dark
    Light

Article summary

The API endpoint `/cdm/client//customer//move/` is designed to transfer a Customer or Patient between product groups within the same client. It requires specific header and path parameters, including an API key, client ID, customer ID, and product group ID, all of which are mandatory. The maximum length for the customer ID and product group ID is 100 characters. Successful requests return a 200 OK status, confirming the move, along with a success message. Various error responses are possible, including 400 for invalid requests, 401 for unauthorized access, 404 for not found resources, 409 for conflicts (such as duplicate IDs), and 500 for unexpected server errors. Each error response provides additional information to assist in troubleshooting. This API facilitates efficient management of customer data within different product groups.

Put
/cdm/client/{client_id}/customer/{ccid}/move/{product_group_id}

This API moves a Customer or Patient from one product group to another product group within the same client.

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
product_group_id
stringRequired

The product group for a Customer or Patient.

Max length100
Exampledefault
Responses
200

OK - Customer or Patient was successfully moved to a new Product Group.

object

Example message success details.

message
string
Max length100
ExampleCustomer {ccid} moved to product-group-test-2 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?