Appearance

Update Contacts ​

Endpoint ​

http
PATCH /unified/crm/contacts/{id}
Integrations supported
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM

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.

  • 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.

Defaults to unified.

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. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

first_name
string

The contact's first name

Required in
  • Capsule
Supported in
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
last_name
string

The contact's last name

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
email_addresses
object[]
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Wix
  • Zendesk Sell
  • Zoho CRM
id
string

The unique identifier of the email addresses

email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The unique identifier of the phone number

number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

All possible enum values:
  • phone
  • mobile
  • home
  • other
  • assistant
  • fax
  • work
custom_fields
object

Custom fields to be set on the contact

Example: { "custom_field_name_1": "foo", "custom_field_name_2": "bar" }
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
title
string

The contact's job title

Supported in
  • Capsule
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Pipeliner
  • Planhat
  • Salesforce
  • Wix
  • Zendesk Sell
  • Zoho CRM
addresses
object[]
Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipeliner
  • Salesflare
  • Salesforce
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The unique identifier of the address

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
  • Capsule
  • Freshsales
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The account's unique identifier

name
string

The account's name

tags
object[]

The contact's tags

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • Planhat
  • Salesflare
  • Teamleader
  • Zendesk Sell
  • Zoho CRM
id
string

The tag's unique identifier

name
string

The tag's name

owner
object

The account's owner

Supported in
  • Highlevel
  • Keap
  • Pipeliner
  • Salesflare
id
string
REQUIRED · 

The owner's unique identifier

description
Supported in
  • Capsule
name
string

The contact's full name

Required in
  • Nutshell
Supported in
  • Planhat
  • Zendesk Sell
phone_number
Supported in
  • Wix
etag
string

The unique identifier for the specific version of the resource.

Required in
  • Wix
phone_numbesr
Supported in
  • Pipeliner
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • Pipeliner
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
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
first_name
string

The contact's first name

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
last_name
string

The contact's last name

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
name
string

The contact's full name

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
title
string

The contact's job title

Supported in
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Pipeliner
  • Planhat
  • Wix
  • Zendesk Sell
account
object

The contact's account

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Zendesk Sell
id
string

The account's unique identifier

name
string

The account's name

addresses
object[]
Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipeliner
  • Salesflare
  • Wix
  • Zendesk Sell
id
string

The unique identifier of the address

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
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
id
string

The unique identifier of the email addresses

email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
id
string

The unique identifier of the phone number

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
  • Capsule
  • Freshsales
  • Highlevel
  • Insightly
  • Nutshell
  • Planhat
  • Salesflare
  • Zendesk Sell
id
string

The tag's unique identifier

name
string

The tag's name

custom_fields
object

All the custom fields present on the contact

Supported in
  • Capsule
  • Close
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Planhat
  • Salesflare
  • Zendesk Sell
last_activity_at
string · date-time

The date and time of the contact's last activity

Supported in
  • Capsule
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Outreach
  • Pipedrive
  • Planhat
  • Wix
created_at
string · date-time

The date and time of the contact's creation

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
updated_at
string · date-time

The date and time of the contact's last update

Supported in
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Nutshell
  • Outreach
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesflare
  • Wix
  • Zendesk Sell
etag
string

The unique identifier for the specific version of the resource.

Supported in
  • Pipeliner
  • Wix
owner
object

The account's owner

Supported in
  • Highlevel
  • Keap
  • Nutshell
  • Pipeliner
  • Salesflare
id
string

The owner's unique identifier

urls
object[]

The contact's urls

Supported in
  • Highlevel
  • Pipedrive
url
string

The contact's URL

type
string

The contact's URL type

remote_data
object

Raw data returned from the remote API call.