Skip to content
POST /unified/crm/contacts

Query Parameters

Refer Specifying query parameters in Truto APIs

workspaceobject
1 supported1 required
Highlevel
required
idstring
required
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 account to be associated with this contact.

References: Accounts → id
20 supported3 required
Close
required
Planhat
required
Zoho CRM
required
Affinity
supported
Attio
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring
required·

The unique identifier for the account.

namestring

The account's name

addressesobject[]
15 supported
Attio
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Wix
supported
Zendesk Sell
supported
citystring

The city

countrystring

The country

idstring

The unique identifier of the address

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

created_atstring · date-time

The date and time of the contact's creation

18 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

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" }
14 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
description
1 supported
Capsule
supported
email_addressesobject[]
22 supported9 required
Affinity
required
Freshsales
required
Highlevel
required
HubSpot
required
Outreach
required
Planhat
required
Salesflare
required
Salesforce
required
Wix
required
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
emailstring
required·

The email address

idstring

The unique identifier of the email addresses

typestring

The email address type

first_namestring

The contact's first name

23 supported15 required
Affinity
required
Attio
required
Capsule
required
Close
required
Microsoft Dynamics 365 Sales
required
HubSpot
required
Insightly
required
Outreach
required
Pipedrive
required
Pipeliner
required
Salesflare
required
Salesforce
required
Teamleader
required
Wix
required
Zoho CRM
required
Copper
supported
Freshsales
supported
Highlevel
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Planhat
supported
Zendesk Sell
supported
job_title
1 supported
OnePageCRM
supported
last_namestring

The contact's last name

23 supported8 required
Affinity
required
Attio
required
Microsoft Dynamics 365 Sales
required
Salesflare
required
Salesforce
required
Teamleader
required
Wix
required
Zoho CRM
required
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
namestring

The contact's full name

19 supported4 required
Copper
required
Monday CRM
required
Nutshell
required
Zendesk Sell
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
ownerobject

The account's owner

8 supported1 required
Pipeliner
required
Highlevel
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Zendesk Sell
supported
idstring
required·

The owner's unique identifier

phone_number
1 supported1 required
Wix
required
phone_numbersobject[]
19 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
numberstring
required·

The phone number

idstring

The unique identifier of the phone number

typestring

The phone number type

Possible values:
phonemobilefaxworkmobilefaxphonemobilehomeotherassistantfax
phone_numbesr
1 supported
Pipeliner
supported
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.

tagsobject[]

The contact's tags

10 supported
Capsule
supported
Copper
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
idstring

The tag's unique identifier

namestring

The tag's name

titlestring

The contact's job title

16 supported1 required
Wix
required
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported

Response Body

idstring
required·

The contact's unique identifier

21 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Salesflare
supported
Wix
supported
Zendesk Sell
supported
accountobject

The contact's account

References: Accounts → id
19 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring

The account's unique identifier

namestring

The account's name

addressesobject[]
15 supported
Attio
supported
Capsule
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipeliner
supported
Wix
supported
Zendesk Sell
supported
citystring

The city

countrystring

The country

idstring

The unique identifier of the address

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

created_atstring · date-time

The date and time of the contact's creation

18 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
custom_fieldsRecord<string, any>

All the custom fields present on the contact

14 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
email_addressesobject[]
20 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
emailstring

The email address

idstring

The unique identifier of the email addresses

typestring

The email address type

etagstring

The unique identifier for the specific version of the resource.

2 supported
Pipeliner
supported
Wix
supported
first_namestring

The contact's first name

19 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
last_activity_atstring · date-time

The date and time of the contact's last activity

10 supported
Affinity
supported
Capsule
supported
Copper
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Outreach
supported
Planhat
supported
Wix
supported
last_namestring

The contact's last name

19 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
namestring

The contact's full name

19 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
ownerobject

The account's owner

8 supported
Highlevel
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The owner's unique identifier

phone_numbersobject[]
19 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
extensionstring

The extension of the phone number

idstring

The unique identifier 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.

tagsobject[]

The contact's tags

10 supported
Capsule
supported
Copper
supported
Freshsales
supported
Highlevel
supported
Insightly
supported
Nutshell
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
idstring

The tag's unique identifier

namestring

The tag's name

titlestring

The contact's job title

16 supported
Attio
supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
Nutshell
supported
OnePageCRM
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
updated_atstring · date-time

The date and time of the contact's last update

17 supported
Capsule
supported
Close
supported
Copper
supported
Microsoft Dynamics 365 Sales
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
Monday CRM
supported
OnePageCRM
supported
Outreach
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Wix
supported
Zendesk Sell
supported
urlsobject[]

The contact's urls

7 supported
Attio
supported
Close
supported
Highlevel
supported
Monday CRM
supported
OnePageCRM
supported
Pipedrive
supported
Zendesk Sell
supported
typestring

The contact's URL type

urlstring

The contact's URL

curl -X POST 'https://api.truto.one/unified/crm/contacts?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",
  "email_addresses": [],
  "account": {},
  "name": "your_name",
  "title": "your_title",
  "phone_numbers": [],
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "addresses": [],
  "tags": [],
  "created_at": "your_created_at",
  "owner": {},
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "email_addresses": [],
  "account": {},
  "name": "your_name",
  "title": "your_title",
  "phone_numbers": [],
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "addresses": [],
  "tags": [],
  "created_at": "your_created_at",
  "owner": {},
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/contacts?integrated_account_id=${integratedAccountId}`, {
  method: 'POST',
  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/contacts"
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",
    "email_addresses": [],
    "account": {},
    "name": "your_name",
    "title": "your_title",
    "phone_numbers": [],
    "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
    "addresses": [],
    "tags": [],
    "created_at": "your_created_at",
    "owner": {},
    "remote_data": {}
}

response = requests.post(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.create(
  'crm',
  'contacts',
  {
  "first_name": "your_first_name",
  "last_name": "your_last_name",
  "email_addresses": [],
  "account": {},
  "name": "your_name",
  "title": "your_title",
  "phone_numbers": [],
  "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
  "addresses": [],
  "tags": [],
  "created_at": "your_created_at",
  "owner": {},
  "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.create(
        "crm",
        "contacts",
        {
        "first_name": "your_first_name",
        "last_name": "your_last_name",
        "email_addresses": [],
        "account": {},
        "name": "your_name",
        "title": "your_title",
        "phone_numbers": [],
        "custom_fields": "{\n  \"custom_field_name_1\": \"foo\",\n  \"custom_field_name_2\": \"bar\"\n}\n",
        "addresses": [],
        "tags": [],
        "created_at": "your_created_at",
        "owner": {},
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())