Update Specific Contact by Type: /accounts/{id}/contacts/$contact_type$
PUT
https://dev-api.exsited.com/api/v3/accounts/{{account_id}}/contacts/CONTACT_1
Try It Out
Purpose
This API updates the contact information of a specified type (e.g., billing or shipping) for a specific account. It allows partial or full updates to fields such as address, phone numbers, name, and communication preferences.
Use Case
Used when editing a contact's information—such as changing their phone number, title, or address—within a specific role (e.g., billing contact) under an account.
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| id | String | Unique identifier of the account. |
| contact_type | String | Identifier for the contact type (e.g., CONTACT_1). |
Query Parameters
No query parameters required for this endpoint.
Request Body
JSON
{
"account": {
"contact": {
"salutation": "SALUTATION_NAME",
"designation": "DESIGNATION_NAME",
"first_name": "FIRST_NAME",
"middle_name": "MIDDLE_NAME",
"email": {
"address": "EMAIL_ADDRESS",
"do_not_email": "BOOLEAN_STRING"
},
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"post_code": "POST_CODE",
"city": "CITY",
"state": "STATE",
"country": "COUNTRY",
"phone": {
"country_code": "CC",
"area_code": "AC",
"number": "PHONE_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"fax": {
"country_code": "CC",
"area_code": "AC",
"number": "FAX_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"mobile": {
"country_code": "CC",
"area_code": "AC",
"number": "MOBILE_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"custom_attributes": [],
"receive_billing_information": "BOOLEAN_STRING"
}
}
}
| Field | Type | Description |
|---|---|---|
| salutation | String | Title prefix (e.g., Mr., Ms.). |
| designation | String | Role or job title (e.g., CEO). |
| first_name | String | Contact’s first name. |
| middle_name | String | Middle name of the contact. |
| email.address | String | Contact's email address. |
| email.do_not_email | String | Flag to suppress emails (true/false). |
| address_line_1–5 | String | Mailing address lines. |
| post_code | String | Postal code. |
| city | String | City name. |
| state | String | State or province. |
| country | String | Country name. |
| phone, fax, mobile | Object | Contact numbers and opt-out settings. |
| receive_billing_information | String | Flag to receive billing info (true/false). |
| custom_attributes | Array | Any custom metadata or user-defined fields. |
Response
Returns the updated contact object under the given type for the specified account, including both human-readable and system-level metadata.
JSON
{
"account": {
"contacts": {
"type": "CONTACT_TYPE",
"type_display_name": "TYPE_DISPLAY_NAME",
"billing_contact": "BOOLEAN_STRING",
"shipping_contact": "BOOLEAN_STRING",
"salutation": {
"id": SALUTATION_ID,
"name": "SALUTATION_NAME",
"link": "SALUTATION_LINK"
},
"designation": {
"id": DESIGNATION_ID,
"name": "DESIGNATION_NAME",
"link": "DESIGNATION_LINK"
},
"first_name": "FIRST_NAME",
"middle_name": "MIDDLE_NAME",
"last_name": "LAST_NAME",
"email": {
"address": "EMAIL_ADDRESS",
"do_not_email": "BOOLEAN_STRING"
},
"address_line_1": "ADDRESS_LINE_1",
"address_line_2": "ADDRESS_LINE_2",
"address_line_3": "ADDRESS_LINE_3",
"address_line_4": "ADDRESS_LINE_4",
"address_line_5": "ADDRESS_LINE_5",
"post_code": "POST_CODE",
"city": "CITY",
"state": "STATE",
"country": "COUNTRY",
"phone": {
"country_code": "CC",
"area_code": "AC",
"number": "PHONE_NUMBER",
"full": "FULL_NUMBER",
"do_not_call": "BOOLEAN_STRING"
},
"fax": {
"country_code": "CC",
"area_code": "AC",
"number": "FAX_NUMBER",
"full": "FULL_FAX",
"do_not_call": "BOOLEAN_STRING"
},
"mobile": {
"country_code": "CC",
"area_code": "AC",
"number": "MOBILE_NUMBER",
"full": "FULL_MOBILE",
"do_not_call": "BOOLEAN_STRING"
},
"receive_billing_information": "BOOLEAN_STRING",
"created_by": "CREATOR_NAME",
"created_on": "CREATED_TIMESTAMP",
"last_updated_by": "UPDATER_NAME",
"last_updated_on": "UPDATED_TIMESTAMP",
"uuid": "CONTACT_UUID",
"version": "VERSION",
"custom_attributes": []
},
"id": "ACCOUNT_ID"
}
}
| Field | Type | Description |
|---|---|---|
| type | String | Type of contact (CONTACT_1, CONTACT_2, etc). |
| type_display_name | String | Human-readable type (e.g., "Billing Contact"). |
| billing_contact | String | Whether this is the billing contact. |
| shipping_contact | String | Whether this is the shipping contact. |
| salutation | Object | Salutation details with id, name, and link. |
| designation | Object | Designation info with id, name, and link. |
| first_name | String | First name of the contact. |
| middle_name | String | Middle name of the contact. |
| last_name | String | Last name of the contact. |
| email.address | String | Email address. |
| email.do_not_email | String | Email opt-out flag (true/false). |
| address_line_1–5 | String | Address fields for mailing purposes. |
| post_code | String | Postal code. |
| city, state, country | String | Location info. |
| phone, fax, mobile | Object | Full number, segmented parts, and opt-out flags. |
| receive_billing_information | String | Indicates if billing info should be sent here. |
| created_by, last_updated_by | String | Creator and last updater of the contact. |
| created_on, last_updated_on | String | Timestamps of creation and update. |
| uuid | UUID | Unique ID of the contact. |
| version | String | Version control metadata. |
| custom_attributes | Array | Custom user-defined metadata. |