Appearance

Update Leads ​

Endpoint ​

http
PATCH /unified/crm/leads/{id}
Integrations supported
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • 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

title
string

The lead's title

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
owner
object

The lead's owner

Supported in
  • Insightly
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The lead's owner's unique identifier

contact
object

The contact associated with the lead

Supported in
  • Pipedrive
id
string

The contact's unique identifier

account
object

The lead's account

Supported in
  • Pipedrive
  • Salesforce
id
string

The account's unique identifier

custom_fields
object

All the custom fields present on the lead

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Pipedrive
  • Salesforce
  • Zendesk Sell
first_name
string

The lead's first name

Supported in
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
last_name
string

The lead's last name

Supported in
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
lead_source
string

The lead's source

Supported in
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
email_addresses
object[]
Supported in
  • Insightly
  • Monday CRM
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
email
string
REQUIRED · 

The email address

type
string
REQUIRED · 

The email address type

All possible enum values:
  • primary
  • secondary
phone_numbers
object[]
Supported in
  • Insightly
  • Monday CRM
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
number
string
REQUIRED · 

The phone number

extension
string

The extension of the phone number

type
string
REQUIRED · 

The phone number type

All possible enum values:
  • phone
  • fax
  • work
  • mobile
email
string
is_primary
string
addresses
object[]
Supported in
  • Insightly
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
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

converted_contact
object

The lead's converted contact

Supported in
  • Salesforce
id
string

The converted contact's unique identifier

converted_account
object

The lead's converted account

Supported in
  • Salesforce
id
string

The converted account's unique identifier

description
Supported in
  • Pipeliner
  • Zoho CRM
industry
Supported in
  • Zoho CRM
website
Supported in
  • Zoho CRM
number_of_employees
Supported in
  • Zoho CRM
status
string

The lead's status

All possible enum values:
  • new
  • working
  • unqualified
  • attempted to contact
  • new lead
  • contacted
  • qualified
Enum support by integration
  • Zendesk Sell
    • new
    • working
    • unqualified
  • Monday CRM
    • attempted to contact
    • new lead
    • contacted
    • unqualified
    • qualified
Supported in
  • HubSpot
  • Monday CRM
  • Zendesk Sell
  • Zoho CRM
name
Supported in
  • Pipeliner
created_at
string · date-time

The date and time of the lead's creation

Supported in
  • Pipeliner
lead_type
string

The lead's type

Supported in
  • HubSpot
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 lead' unique identifier

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
owner
object

The lead's owner

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
id
string

The lead's owner's unique identifier

lead_source
string

The lead's source

Supported in
  • HubSpot
  • Insightly
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
lead_type
string

The lead's type

Supported in
  • HubSpot
status
string

The lead's status

Supported in
  • HubSpot
  • Monday CRM
  • Nutshell
  • Zendesk Sell
title
string

The lead's title

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Zendesk Sell
contact
object

The contact associated with the lead

Supported in
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
id
string

The contact's unique identifier

account
object

The lead's account

Supported in
  • HubSpot
  • Nutshell
  • Pipedrive
  • Pipeliner
id
string

The account's unique identifier

first_name
string

The lead's first name

Supported in
  • HubSpot
  • Insightly
  • Zendesk Sell
last_name
string

The lead's last name

Supported in
  • HubSpot
  • Insightly
  • Zendesk Sell
addresses
object[]
Supported in
  • Insightly
  • Zendesk Sell
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
  • HubSpot
  • Insightly
  • Monday CRM
  • Zendesk Sell
email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Insightly
  • Monday CRM
  • Zendesk Sell
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

custom_fields
object

All the custom fields present on the lead

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Zendesk Sell
last_activity_at
string · date-time

The date and time of the lead's last activity

Supported in
  • HubSpot
  • Insightly
  • Nutshell
created_at
string · date-time

The date and time of the lead's creation

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
updated_at
string · date-time

The date and time of the lead's last update

Supported in
  • HubSpot
  • Insightly
  • Monday CRM
  • Nutshell
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
converted_at
string · date-time

The date and time of the lead's conversion

Supported in
  • Insightly
  • Pipeliner
converted_contact
string

The lead's converted contact

Supported in
  • Insightly
converted_account
string

The lead's converted account

Supported in
  • Insightly
urls
object[]

The lead's urls

Supported in
  • Monday CRM
  • Pipedrive
  • Zendesk Sell
url
string

The lead's URL

type
string

The lead's URL type

remote_data
object

Raw data returned from the remote API call.