Skip to content

Update Contacts

Endpoint

http
PATCH /unified/crm/contacts/{id}
Integrations supported
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce

Path parameters

id
string
REQUIRED · The ID of the resource.
Example: 23423523

Query parameters

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string
The format of the response. Defaults to `unified`. `unified` will return the response with unified mappings applied. `raw` will return the raw response from the remote API. `normalized` will apply the unified mappings and return the data in a normalized format.
All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_ignore_remote_data
boolean
Excludes the `remote_data` attribute from the response.
truto_exclude_fields
array
Array of fields to exclude from the response.
Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object
Query parameters to pass to the underlying API without any transformations.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

first_name
string
The contact's first name
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
last_name
string
The contact's last name
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
email_addresses
object[]
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
email
string
The email address
type
string
The email address type
phone_numbers
object[]
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
number
string
The phone number
extension
string
The extension of the phone number
type
string
The phone number type
custom_fields
object
Custom fields to be set on the contact. The custom_fields object will be a key-value pair, where the key will be the `name` attribute of the custom field found in the response of https://truto.one/docs/api-reference/unified-crm-api/fields/list endpoint.
Example: { "custom_field_name_1": "foo", "custom_field_name_2": "bar" }
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
  • Salesforce
addresses
object[]
Supported in
  • Highlevel
  • HubSpot
  • Salesforce
street_1
string
Line 1 of the street address
street_2
string
Line 2 of the street address
city
string
The city
state
string
The state
postal_code
string
The postal code
country
string
The country
type
string
The address type
account
object
The contact's account
Supported in
  • Pipedrive
  • Salesforce
id
string
The account's unique identifier
name
string
The account's name
tags
object[]
The contact's tags
Supported in
  • Highlevel
id
string
The tag's unique identifier
name
string
The tag's name
remote_data
object
Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body

id
string
REQUIRED · The contact's unique identifier
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
first_name
string
The contact's first name
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
last_name
string
The contact's last name
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
name
string
The contact's full name
Supported in
  • Highlevel
  • HubSpot
  • Pipedrive
title
string
The contact's job title
Supported in
  • Close
  • HubSpot
account
object
The contact's account
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
id
string
The account's unique identifier
name
string
The account's name
addresses
object[]
Supported in
  • Highlevel
  • HubSpot
street_1
string
Line 1 of the street address
street_2
string
Line 2 of the street address
city
string
The city
state
string
The state
postal_code
string
The postal code
country
string
The country
type
string
The address type
email_addresses
object[]
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
email
string
The email address
type
string
The email address type
phone_numbers
object[]
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
number
string
The phone number
extension
string
The extension of the phone number
type
string
The phone number type
tags
object[]
The contact's tags
Supported in
  • Highlevel
id
string
The tag's unique identifier
name
string
The tag's name
last_activity_at
string · date-time
The date and time of the contact's last activity
Supported in
  • HubSpot
  • Pipedrive
created_at
string · date-time
The date and time of the contact's creation
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
updated_at
string · date-time
The date and time of the contact's last update
Supported in
  • Close
  • Highlevel
  • HubSpot
  • Pipedrive
remote_data
object
Raw data returned from the remote API call.