Skip to content
PATCH /unified/crm/leads/{id}

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

Show Truto-specific parameters
integrated_account_idstring · uuid
required·

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_formatstring

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstream
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_exclude_fieldsstring[]

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_queryRecord<string, any>

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

accountobject

The lead's account

References: Accounts → id
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
idstring

The account's unique identifier

addressesobject[]
3 supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Zendesk Sell
supported
citystring

The city

countrystring

The country

postal_codestring

The postal code

statestring

The state

street_1string

Line 1 of the street address

street_2string

Line 2 of the street address

typestring

The address type

contactobject

The contact associated with the lead

References: Contacts → id
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
idstring

The contact's unique identifier

converted_accountobject

The lead's converted account

1 supported
Insightly
supported
idstring

The converted account's unique identifier

converted_contactobject

The lead's converted contact

1 supported
Insightly
supported
idstring

The converted contact's unique identifier

created_atstring · date-time

The date and time of the lead's creation

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

All the custom fields present on the lead

6 supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Zendesk Sell
supported
description
2 supported
Pipeliner
supported
Zoho CRM
supported
email_addressesobject[]
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Zendesk Sell
supported
emailstring
required·

The email address

typestring
required·

The email address type

Possible values:
primarysecondaryprimarysecondary
first_namestring

The lead's first name

4 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Zendesk Sell
supported
industry
1 supported
Zoho CRM
supported
last_namestring

The lead's last name

4 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Zendesk Sell
supported
lead_sourcestring

The lead's source

Possible values:
AdvertisementEmployee ReferralExternal ReferralPartnerPublic RelationsSeminarTrade ShowWebWord of MouthOther
7 supported
Microsoft Dynamics 365 Sales
supported
AdvertisementEmployee ReferralExternal ReferralPartnerPublic RelationsSeminarTrade ShowWebWord of MouthOther
HubSpot
supported
Insightly
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
lead_typestring

The lead's type

1 supported
HubSpot
supported
name
1 supported
Pipeliner
supported
number_of_employees
1 supported
Zoho CRM
supported
ownerobject

The lead's owner

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The lead's owner's unique identifier

phone_numbersobject[]
4 supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Monday CRM
supported
Zendesk Sell
supported
numberstring
required·

The phone number

typestring
required·

The phone number type

Possible values:
workmobilefaxphonefaxphonefax
emailstring
extensionstring

The extension of the phone number

is_primarystring
remote_dataRecord<string, any>

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.

statusstring

The lead's status

Possible values:
attempted to contactnew leadcontactedunqualifiedqualifiednewworkingunqualified
4 supported
Monday CRM
supported
attempted to contactnew leadcontactedunqualifiedqualified
Zendesk Sell
supported
newworkingunqualified
HubSpot
supported
Nutshell
supported
titlestring

The lead's title

7 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Zendesk Sell
supported
website
1 supported
Zoho CRM
supported

Response Body

idstring
required·

The lead' unique identifier

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
accountobject

The lead's account

References: Accounts → id
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
idstring

The account's unique identifier

addressesobject[]
3 supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Zendesk Sell
supported
citystring

The city

countrystring

The country

postal_codestring

The postal code

statestring

The state

street_1string

Line 1 of the street address

street_2string

Line 2 of the street address

typestring

The address type

contactobject

The contact associated with the lead

References: Contacts → id
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
idstring

The contact's unique identifier

converted_accountstring

The lead's converted account

1 supported
Insightly
supported
converted_atstring · date-time

The date and time of the lead's conversion

2 supported
Insightly
supported
Pipeliner
supported
converted_contactstring

The lead's converted contact

1 supported
Insightly
supported
created_atstring · date-time

The date and time of the lead's creation

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

All the custom fields present on the lead

6 supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Zendesk Sell
supported
email_addressesobject[]
5 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Zendesk Sell
supported
emailstring

The email address

typestring

The email address type

first_namestring

The lead's first name

4 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Zendesk Sell
supported
last_activity_atstring · date-time

The date and time of the lead's last activity

3 supported
HubSpot
supported
Insightly
supported
Nutshell
supported
last_namestring

The lead's last name

4 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Zendesk Sell
supported
lead_sourcestring

The lead's source

7 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
lead_typestring

The lead's type

1 supported
HubSpot
supported
ownerobject

The lead's owner

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The lead's owner's unique identifier

phone_numbersobject[]
4 supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Monday CRM
supported
Zendesk Sell
supported
extensionstring

The extension of the phone number

numberstring

The phone number

typestring

The phone number type

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The lead's status

4 supported
HubSpot
supported
Monday CRM
supported
Nutshell
supported
Zendesk Sell
supported
titlestring

The lead's title

7 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Zendesk Sell
supported
updated_atstring · date-time

The date and time of the lead's last update

8 supported
Microsoft Dynamics 365 Sales
supported
HubSpot
supported
Insightly
supported
Monday CRM
supported
Nutshell
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
urlsobject[]

The lead's urls

3 supported
Monday CRM
supported
Pipedrive
supported
Zendesk Sell
supported
typestring

The lead's URL type

urlstring

The lead's URL

curl -X PATCH 'https://api.truto.one/unified/crm/leads/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "owner": {},
  "lead_source": "Advertisement",
  "title": "your_title",
  "account": {},
  "contact": {},
  "addresses": [],
  "email_addresses": [],
  "phone_numbers": [],
  "lead_type": "your_lead_type",
  "status": "attempted to contact",
  "custom_fields": {},
  "created_at": "your_created_at",
  "converted_contact": {},
  "converted_account": {},
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "owner": {},
  "lead_source": "Advertisement",
  "title": "your_title",
  "account": {},
  "contact": {},
  "addresses": [],
  "email_addresses": [],
  "phone_numbers": [],
  "lead_type": "your_lead_type",
  "status": "attempted to contact",
  "custom_fields": {},
  "created_at": "your_created_at",
  "converted_contact": {},
  "converted_account": {},
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/leads/{id}?integrated_account_id=${integratedAccountId}`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <your_api_token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import requests

url = "https://api.truto.one/unified/crm/leads/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "first_name": "your_first_name",
    "last_name": "your_last_name",
    "owner": {},
    "lead_source": "Advertisement",
    "title": "your_title",
    "account": {},
    "contact": {},
    "addresses": [],
    "email_addresses": [],
    "phone_numbers": [],
    "lead_type": "your_lead_type",
    "status": "attempted to contact",
    "custom_fields": {},
    "created_at": "your_created_at",
    "converted_contact": {},
    "converted_account": {},
    "remote_data": {}
}

response = requests.patch(url, headers=headers, params=params, json=payload)
print(response.json())
import Truto from '@truto/truto-ts-sdk';

const truto = new Truto({
  token: '<your_api_token>',
});

const result = await truto.unifiedApi.update(
  'crm',
  'leads',
  '<resource_id>',
  {
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "owner": {},
  "lead_source": "Advertisement",
  "title": "your_title",
  "account": {},
  "contact": {},
  "addresses": [],
  "email_addresses": [],
  "phone_numbers": [],
  "lead_type": "your_lead_type",
  "status": "attempted to contact",
  "custom_fields": {},
  "created_at": "your_created_at",
  "converted_contact": {},
  "converted_account": {},
  "remote_data": {}
},
  { integrated_account_id: '<integrated_account_id>' }
);

console.log(result);
import asyncio
from truto_python_sdk import TrutoApi

truto_api = TrutoApi(token="<your_api_token>")

async def main():
    result = await truto_api.unified_api.update(
        "crm",
        "leads",
        "<resource_id>",
        {
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "owner": {},
        "lead_source": "Advertisement",
        "title": "your_title",
        "account": {},
        "contact": {},
        "addresses": [],
        "email_addresses": [],
        "phone_numbers": [],
        "lead_type": "your_lead_type",
        "status": "attempted to contact",
        "custom_fields": {},
        "created_at": "your_created_at",
        "converted_contact": {},
        "converted_account": {},
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())