- 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
Add phone number
- Updated on 19 Nov 2024
- 1 Minute to read
- Print
- DarkLight
The API endpoint `/cdm/client//customer//add phone/` is designed to add a phone number to a Customer or Patient record. It requires specific header and path parameters, including an API key, client ID, and a unique customer or patient identifier (ccid). The phone number must be between 10 to 11 digits long. The request body includes parameters for consent type, phone type, country code, and client source, with specific valid values for each. Upon successful execution, the phone number is added to the customer's notification channels, with a limit of 50 phone numbers per CCID and 50 CCIDs per phone number. The API responds with various status codes, including 200 for success, 400 for invalid requests, 401 for unauthorized access, 404 for not found, 409 for conflicts, and 500 for server errors, providing relevant messages for each scenario.
This API adds a phone number to 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 adds the phone number to the array of notification channels in the Customer or Patient record. Currently, relay permits up to 50 phone numbers associated to one CCID and up to 50 CCIDs can be associated to a specific phone number.
Request body for Add Phone.
Identifies the consent of the Customer or Patient.
Type of phone line of the Customer or Patient.
The country code of the phone_type. Defaults to 1.
The source provided by the client of the channel. Defaults to an internal channel.
OK - The phone number was successfully added to 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.