Skip to content
POST /unified/crm/notes

Query Parameters

Refer Specifying query parameters in Truto APIs

contactobject[]

The note's contact

References: Contacts → id
1 supported1 required
Highlevel
required
idstring
required·

The contact's unique identifier

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.
  • debug returns the final unified result alongside raw remote fetch information. The response is an envelope containing result (identical to unified mode output) and debug (with requestUrl, requestOptions, data, responseHeaders, and for list operations: nextCursor, isLooping, isEmptyResult, resultCount). debug is null for static responses or when truto_skip_api_call=true.

Defaults to unified.

Example: unified
Possible values:
unifiedrawnormalizedstreamdebug
truto_ignore_remote_databoolean

Excludes the remote_data attribute from the response.

truto_enforce_write_schemaboolean

Validates the request body against this method's request_body_schema before the request is sent to the underlying integration. When a field marked required is missing, Truto responds 400 with the missing field names under truto_error_insight.missing_required_body_fields instead of forwarding the call. Only the fields documented in request_body_schema are checked. A body carrying a non-empty remote_data object is forwarded unchecked, because remote_data is merged into the provider request and may already carry the required values. A field the mapping always supplies through its default body is treated as present, and a field that is only conditionally required is reported under truto_error_insight.conditionally_required_body_fields rather than rejected. Some integrations declare fields required on update that the provider only requires on create; check meta/{method} for the resource before enabling this on update calls. If you sent an Idempotency-Key and the request was rejected, use a fresh key when you retry with a corrected body: the idempotency cache is keyed on the integrated account, path and key only — it ignores the query string and the body — so reusing the key replays the rejection. Defaults to false, which forwards the request as-is.

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

One of contact, account or opportunity or lead is required

References: Accounts → id
9 supported2 required
Close
required
Planhat
required
Affinity
supported
Attio
supported
Capsule
supported
Freshsales
supported
HubSpot
supported
Pipedrive
supported
Pipeliner
supported
idstring
required·

The account's unique identifier

contactobject[]

One of contact, account or opportunity or lead is required

References: Contacts → id
14 supported2 required
Keap
required
OnePageCRM
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Nimble
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
properties
type
idstring
required·

The contact's unique identifier

contentstring

Either title or content is required.

15 supported11 required
Affinity
required
Attio
required
Capsule
required
Freshsales
required
Highlevel
required
Nimble
required
OnePageCRM
required
Pipedrive
required
Pipeliner
required
Zendesk Sell
required
Zoho CRM
required
Close
supported
HubSpot
supported
Keap
supported
Planhat
supported
content_type
Possible values:
htmlplain_textplaintextmarkdown
2 supported
Affinity
supported
htmlplain_text
Attio
supported
plaintextmarkdown
created_atstring · date-time

The date and time of the note's creation

14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
creator_id
1 supported
Affinity
supported
custom_fields
1 supported
Planhat
supported
leadobject[]

One of contact, account or opportunity or lead is required

References: Leads → id
3 supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring
required·

The lead's unique identifier

opportunityobject[]

One of contact, account or opportunity or lead is required

9 supported
Affinity
supported
Attio
supported
Capsule
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
properties
type
idstring
required·

The opportunity's unique identifier

opportunity_ids
1 supported
Affinity
supported
organization_ids
1 supported
Affinity
supported
ownerobject

The note's owner

14 supported3 required
Keap
required
Nimble
required
Pipeliner
required
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
idstring
required·

The note's owner's unique identifier

person_ids
1 supported
Affinity
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.

titlestring

Either title or content is required.

5 supported2 required
Attio
required
Salesforce
required
Keap
supported
Nimble
supported
Planhat
supported
urlsobject[]

The note's urls

2 supported
Attio
supported
Zendesk Sell
supported
typestring

The note's URL type

urlstring

The note's URL

visibilitystring

The note's visibility

Possible values:
publicprivatepublicprivate

Response Body

idstring
required·

The note's unique identifier

14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
accountobject

The note's account

References: Accounts → id
9 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
idstring

The account's unique identifier

contactobject[]

The note's contact

References: Contacts → id
14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring

The contact's unique identifier

contentstring

The note's content

14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
created_atstring · date-time

The date and time of the note's creation

14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
leadobject[]

The note's leads

References: Leads → id
3 supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The lead's unique identifier

opportunityobject[]

The note's opportunities

9 supported
Affinity
supported
Attio
supported
Capsule
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring

The opportunity's unique identifier

ownerobject

The note's owner

14 supported
Affinity
supported
Attio
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring

The note's owner's unique identifier

remote_dataRecord<string, any>

Raw data returned from the remote API call.

titlestring

The note's title

4 supported
Attio
supported
Keap
supported
Nimble
supported
Planhat
supported
updated_atstring · date-time

The date and time of the note's last update

11 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Keap
supported
Nimble
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
urlsobject[]

The note's urls

2 supported
Attio
supported
Zendesk Sell
supported
typestring

The note's URL type

urlstring

The note's URL

visibilitystring

The note's visibility

Possible values:
publicprivate
truto unified crm notes \
  -m create \
  -a '<integrated_account_id>' \
  -b '{
  "content": "your_content",
  "created_at": "your_created_at",
  "content_type": "html",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "visibility": "public",
  "urls": [],
  "remote_data": {}
}' \
  -o json
import Truto from '@truto/truto-ts-sdk';

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

const result = await truto.unifiedApi.create(
  'crm',
  'notes',
  {
  "content": "your_content",
  "created_at": "your_created_at",
  "content_type": "html",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "visibility": "public",
  "urls": [],
  "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",
        "notes",
        {
        "content": "your_content",
        "created_at": "your_created_at",
        "content_type": "html",
        "owner": {},
        "contact": [],
        "account": {},
        "opportunity": [],
        "title": "your_title",
        "lead": [],
        "visibility": "public",
        "urls": [],
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())
curl -X POST 'https://api.truto.one/unified/crm/notes?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "your_content",
  "created_at": "your_created_at",
  "content_type": "html",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "visibility": "public",
  "urls": [],
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "content": "your_content",
  "created_at": "your_created_at",
  "content_type": "html",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "visibility": "public",
  "urls": [],
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/notes?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/notes"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "content": "your_content",
    "created_at": "your_created_at",
    "content_type": "html",
    "owner": {},
    "contact": [],
    "account": {},
    "opportunity": [],
    "title": "your_title",
    "lead": [],
    "visibility": "public",
    "urls": [],
    "remote_data": {}
}

response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())