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

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

contactobject[]

The note's contact

References: Contacts → id
12 supported1 required
Highlevel
required
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
HubSpot
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
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.

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

Account associated with the note. One of contact, account and opportunity is always required.

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

The account's unique identifier

contactobject[]

Contact associated with the note. One of contact, account and opportunity is always required.

References: Contacts → id
12 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring
required·

The contact's unique identifier

contentstring

The note's content

13 supported2 required
Affinity
required
Freshsales
required
Capsule
supported
Close
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
custom_fields
1 supported
Planhat
supported
leadobject[]

The note's leads

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

The lead's unique identifier

opportunityobject[]

Opportunity associated with the note. One of contact, account and opportunity is always required.

8 supported
Affinity
supported
Capsule
supported
Freshsales
supported
HubSpot
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
idstring
required·

The opportunity's unique identifier

ownerobject

The note's owner

13 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring
required·

The note's owner's unique identifier

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

The note's title

3 supported
Insightly
supported
Keap
supported
Planhat
supported

Response Body

idstring
required·

The note's unique identifier

13 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
accountobject

The note's account

References: Accounts → id
8 supported
Affinity
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
12 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Planhat
supported
Zendesk Sell
supported
idstring

The contact's unique identifier

contentstring

The note's content

13 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
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

13 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
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

8 supported
Affinity
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

13 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Highlevel
supported
HubSpot
supported
Insightly
supported
Keap
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

3 supported
Insightly
supported
Keap
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
Insightly
supported
Keap
supported
OnePageCRM
supported
Pipedrive
supported
Pipeliner
supported
Zendesk Sell
supported
urlsobject[]

The note's urls

1 supported
Zendesk Sell
supported
typestring

The note's URL type

urlstring

The note's URL

visibilitystring

The note's visibility

Possible values:
publicprivate
curl -X PATCH 'https://api.truto.one/unified/crm/notes/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "content": "your_content",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "content": "your_content",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/notes/{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/notes/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "content": "your_content",
    "owner": {},
    "contact": [],
    "account": {},
    "opportunity": [],
    "title": "your_title",
    "lead": [],
    "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',
  'notes',
  '<resource_id>',
  {
  "content": "your_content",
  "owner": {},
  "contact": [],
  "account": {},
  "opportunity": [],
  "title": "your_title",
  "lead": [],
  "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",
        "notes",
        "<resource_id>",
        {
        "content": "your_content",
        "owner": {},
        "contact": [],
        "account": {},
        "opportunity": [],
        "title": "your_title",
        "lead": [],
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())