Skip to navigation
API ReferenceCustomersAPI IntegrationContacts

Update a Contact

Updates an existing contact associated with a specific customer. This endpoint allows you to modify contact information such as address, phone number, and other relevant details. Only the fields included in the request body will be updated; omitted fields will retain their current values (partial update supported). The contact must belong to the specified customer, and appropriate authentication is required to perform this operation.

Authentication: Bearer token required

Authentication

AuthorizationBearer

OAuth 2.0 Bearer token authentication. This API uses OAuth 2.0 Client Credentials flow. Please refer to the Authentication section for detailed information on how to obtain and use your OAuth credentials.

Path parameters

customerIdstringRequired

Unique Customer Identifier. This is the customer_id returned in the response from the Add Contact API.

contactIdstringRequired

Unique ID for this contact. This is the contact_id returned in the response from the Get Customer API.

Request

Contact details to update.
occupationstringOptional
Occupation of the contact.
employment_statusstringOptional
Employment status of the contact.
industrystringOptional
Employment industry of the contact.
phone_numberstringOptional
Contact phone number.
mobile_numberstringOptional

Contact mobile number in E.164 international format (e.g., +14155552671).

primary_contactbooleanOptional
Indicates if this contact is the primary contact for the customer account.
authorize_to_tradebooleanOptional
Indicates whether the contact is authorised to trade on behalf of the customer.
addressobjectOptional
Address details for the contact.

Response

Ok.
customer_idstringOptional
ID of Customer related to the Contact.
contact_idstringOptional
Unique identifier of the contact that was updated.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error