Appearance

Update Leads ​

Endpoint ​

http
PATCH /unified/crm/leads/{id}
Integrations supported
  • 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.

  • 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 lead's first name

Supported in
  • Salesforce
last_name
string

The lead's last name

Supported in
  • Salesforce
title
string

The lead's title

Supported in
  • Salesforce
owner
object

The lead's owner

Supported in
  • Salesforce
id
string

The lead's owner's unique identifier

lead_source
string

The lead's source

Supported in
  • Salesforce
account
object

The lead's account

Supported in
  • Salesforce
id
string

The account's unique identifier

email_addresses
object[]
Supported in
  • Salesforce
email
string

The email address

type
string

The email address type

phone_numbers
object[]
Supported in
  • Salesforce
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

addresses
object[]
Supported in
  • 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

custom_fields
Supported in
  • Salesforce
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

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

owner
object

The lead's owner

id
string

The lead's owner's unique identifier

lead_source
string

The lead's source

title
string

The lead's title

contact
object

The contact associated with the lead

id
string

The contact's unique identifier

account
object

The lead's account

id
string

The account's unique identifier

first_name
string

The lead's first name

last_name
string

The lead's last name

addresses
object[]
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[]
email
string

The email address

type
string

The email address type

phone_numbers
object[]
number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

last_activity_at
string · date-time

The date and time of the lead's last activity

created_at
string · date-time

The date and time of the lead's creation

updated_at
string · date-time

The date and time of the lead's last update

converted_at
string · date-time

The date and time of the lead's conversion

converted_contact
string

The lead's converted contact

converted_account
string

The lead's converted account

remote_data
object

Raw data returned from the remote API call.