post https://prod.api.getborderless.com/contacts/UpdateContactInformation
Introduction
This endpoint allows you to Update information about your External Contact's account.
Data Requirements
Provide the following data requirements when sending a POST request to the Update Contacts endpoint.
Additional Header parameter:
Parameter | Required? | Description | Type |
---|---|---|---|
Client-Id | No | Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. | String |
The body of the request should contain the following properties for the values you wish to update:
Parameter | Required? | Description | Type |
---|---|---|---|
handle | Yes | This is the @handle associated with a contact's account. For an internal contact it appears as @{handle}, for an external contact the format is ^{XXXXX} where X represents randomly generated alphanumeric strings. An example would be ^be39D. | String |
displayName | No | A name to be displayed for your contact. It should be between 1 and 60 alphanumeric characters and accepts only - (dash) , (comma) . (period) & (ampersand) spaces and / (slash) as special characters. | String |
No | The contact's email address. | String | |
clientInternalReference | No | A Client Internal Reference or CIR is a way for your company to internally label a contact. This can be used for grouping various contacts in a category, like EngineeringTeam. It should be between 1 and 60 alphanumeric characters and accepts only spaces \# (pound sign) as special characters. | String |