Appearance

Update Notes ​

Endpoint ​

http
PATCH /unified/crm/notes/{id}
Integrations supported
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM

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
contact
array

The note's contact

Required in
  • Highlevel

Request Body ​

Refer Writing data using Unified APIs

content
string

The note's content

Required in
  • Affinity
  • Freshsales
Supported in
  • Capsule
  • Close
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
account
object

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

Supported in
  • Capsule
  • Freshsales
  • Pipedrive
  • Pipeliner
  • Planhat
id
string
REQUIRED · 

The account's unique identifier

contact
object[]

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

Supported in
  • Capsule
  • Freshsales
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
id
string
REQUIRED · 

The contact's unique identifier

opportunity
object[]

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

Supported in
  • Freshsales
  • Pipedrive
  • Zendesk Sell
id
string
REQUIRED · 

The opportunity's unique identifier

owner
object

The note's owner

Supported in
  • Capsule
  • Freshsales
  • Highlevel
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Salesforce
id
string
REQUIRED · 

The note's owner's unique identifier

lead
object[]

The note's leads

Supported in
  • Pipedrive
  • Zendesk Sell
id
string
REQUIRED · 

The lead's unique identifier

title
string

The note's title

Supported in
  • Insightly
  • Keap
  • Planhat
  • Salesforce
  • Zoho CRM
custom_fields
Supported in
  • Planhat
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 note's unique identifier

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
title
string

The note's title

Supported in
  • Insightly
  • Keap
  • Planhat
owner
object

The note's owner

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
id
string

The note's owner's unique identifier

content
string

The note's content

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
contact
object[]

The note's contact

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
id
string

The contact's unique identifier

account
object

The note's account

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Pipedrive
  • Pipeliner
  • Planhat
id
string

The account's unique identifier

opportunity
object[]

The note's opportunities

Supported in
  • Affinity
  • Capsule
  • Freshsales
  • HubSpot
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
id
string

The opportunity's unique identifier

lead
object[]

The note's leads

Supported in
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
id
string

The lead's unique identifier

visibility
string

The note's visibility

All possible enum values:
  • public
  • private
created_at
string · date-time

The date and time of the note's creation

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Highlevel
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Planhat
  • Zendesk Sell
updated_at
string · date-time

The date and time of the note's last update

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Insightly
  • Keap
  • Pipedrive
  • Pipeliner
  • Zendesk Sell
urls
object[]

The note's urls

Supported in
  • Zendesk Sell
url
string

The note's URL

type
string

The note's URL type

remote_data
object

Raw data returned from the remote API call.