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

Path Parameters

idstring
required·

The ID of the resource.

Example: 23423523

Query Parameters

Refer Specifying query parameters in Truto APIs

engagement_typestring

The engagement's type - call, email, meeting or raw response

Possible values:
callmeeting
10 supported1 required
OnePageCRM
required
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
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 engagement's account

References: Accounts → id
7 supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

References: Contacts → id
10 supported1 required
Affinity
required
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring
required·

The contact's unique identifier

contentstring

The engagement's content

8 supported1 required
Capsule
required
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the engagement's creation

9 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
custom_fieldsRecord<string, any>

All the custom fields present on the engagement

1 supported
Planhat
supported
date_created
1 supported
Close
supported
description
1 supported
Freshsales
supported
directionstring

The engagement's direction. Specify only if engagement_type is call

Possible values:
inboundoutbound
2 supported
Close
supported
Zoho CRM
supported
durationstring

The engagement's duration

3 supported
OnePageCRM
supported
Zendesk Sell
supported
Zoho CRM
supported
end_timestring · date-time

The engagement's end time. Only applicable when engagement_type is meeting.

4 supported
Affinity
supported
Close
supported
Freshsales
supported
Zoho CRM
supported
engagement_typestring

The engagement's type

Possible values:
meetingcallchatcallnoteemailcallemailmeetingcallemailmeeting+ 2 more
12 supported5 required
Affinity
required
meetingcallchat
Close
required
callnoteemail
HubSpot
required
callemailmeeting
Salesforce
required
callemailmeeting
Zoho CRM
required
callmeeting
Capsule
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
internal_notesstring

The engagement's internal notes

leadobject[]

The engagement's lead

References: Leads → id
3 supported
Copper
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The lead's unique identifier

opportunityobject[]

The engagement's opportunity

6 supported
Capsule
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The opportunity's unique identifier

ownerobject

The engagement's owner

9 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The owner's unique identifier

phone_numbersobject[]

Set this value only when engagement type is call.

2 supported
OnePageCRM
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

projectobject

The engagement's project

References: Projects → id
1 supported
Capsule
supported
idstring

The project'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.

start_timestring · date-time

The engagement's start time. Only applicable when engagement_type is meeting.

6 supported
Affinity
supported
Close
supported
Freshsales
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
statusstring

Status associated with the engagement.

Possible values:
inboxdraftscheduledoutboxsent
4 supported
Close
supported
inboxdraftscheduledoutboxsent
Capsule
supported
OnePageCRM
supported
Planhat
supported
subjectstring

The engagement's subject

8 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported

Response Body

idstring
required·

The engagement's unique identifier

10 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
accountobject

The engagement's account

References: Accounts → id
7 supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
idstring

The account's unique identifier

contactobject[]

The engagement's contacts

References: Contacts → id
10 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The contact's unique identifier

contentstring

The engagement's content

8 supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
created_atstring · date-time

The date and time of the engagement's creation

9 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zoho CRM
supported
custom_fieldsRecord<string, any>

All the custom fields present on the engagement

1 supported
Planhat
supported
directionstring

The engagement's direction

2 supported
Close
supported
Zoho CRM
supported
durationstring

The engagement's duration

3 supported
OnePageCRM
supported
Zendesk Sell
supported
Zoho CRM
supported
end_timestring · date-time

The engagement's end time

4 supported
Affinity
supported
Close
supported
Freshsales
supported
Zoho CRM
supported
engagement_typestring

The engagement's type - call, email, meeting or raw response

10 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
internal_notesstring

The engagement's internal notes

leadobject[]

The engagement's lead

References: Leads → id
3 supported
Copper
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The lead's unique identifier

notesobject[]

The engagement's notes

References: Notes → id
1 supported
Affinity
supported
idstring

The note's unique identifier

opportunityobject[]

The engagement's opportunity

6 supported
Capsule
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The opportunity's unique identifier

ownerobject

The engagement's owner

9 supported
Affinity
supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
idstring

The owner's unique identifier

phone_numbersobject[]
2 supported
OnePageCRM
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

projectobject

The engagement's project

References: Projects → id
1 supported
Capsule
supported
idstring

The project's unique identifier

remote_dataRecord<string, any>

Raw data returned from the remote API call.

start_timestring · date-time

The engagement's start time

6 supported
Affinity
supported
Close
supported
Freshsales
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
statusstring

The engagement's status

4 supported
Capsule
supported
Close
supported
OnePageCRM
supported
Planhat
supported
subjectstring

The engagement's subject

8 supported
Affinity
supported
Capsule
supported
Close
supported
Freshsales
supported
Pipedrive
supported
Planhat
supported
Zendesk Sell
supported
Zoho CRM
supported
updated_atstring · date-time

The date and time of the engagement's last update

8 supported
Capsule
supported
Close
supported
Copper
supported
Freshsales
supported
OnePageCRM
supported
Pipedrive
supported
Zendesk Sell
supported
Zoho CRM
supported
curl -X PATCH 'https://api.truto.one/unified/crm/engagements/{id}?integrated_account_id=<integrated_account_id>' \
  -H 'Authorization: Bearer <your_api_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "engagement_type": "meeting",
  "content": "your_content",
  "contact": [],
  "start_time": "your_start_time",
  "created_at": "your_created_at",
  "owner": {},
  "account": {},
  "opportunity": [],
  "project": {},
  "subject": "your_subject",
  "status": "inbox",
  "direction": "inbound",
  "end_time": "your_end_time",
  "lead": [],
  "internal_notes": "your_internal_notes",
  "phone_numbers": [],
  "custom_fields": {},
  "duration": "your_duration",
  "remote_data": {}
}'
const integratedAccountId = '<integrated_account_id>';

const body = {
  "engagement_type": "meeting",
  "content": "your_content",
  "contact": [],
  "start_time": "your_start_time",
  "created_at": "your_created_at",
  "owner": {},
  "account": {},
  "opportunity": [],
  "project": {},
  "subject": "your_subject",
  "status": "inbox",
  "direction": "inbound",
  "end_time": "your_end_time",
  "lead": [],
  "internal_notes": "your_internal_notes",
  "phone_numbers": [],
  "custom_fields": {},
  "duration": "your_duration",
  "remote_data": {}
};

const response = await fetch(`https://api.truto.one/unified/crm/engagements/{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/engagements/{id}"
headers = {
    "Authorization": "Bearer <your_api_token>",
    "Content-Type": "application/json",
}
params = {
    "integrated_account_id": "<integrated_account_id>"
}
payload = {
    "engagement_type": "meeting",
    "content": "your_content",
    "contact": [],
    "start_time": "your_start_time",
    "created_at": "your_created_at",
    "owner": {},
    "account": {},
    "opportunity": [],
    "project": {},
    "subject": "your_subject",
    "status": "inbox",
    "direction": "inbound",
    "end_time": "your_end_time",
    "lead": [],
    "internal_notes": "your_internal_notes",
    "phone_numbers": [],
    "custom_fields": {},
    "duration": "your_duration",
    "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',
  'engagements',
  '<resource_id>',
  {
  "engagement_type": "meeting",
  "content": "your_content",
  "contact": [],
  "start_time": "your_start_time",
  "created_at": "your_created_at",
  "owner": {},
  "account": {},
  "opportunity": [],
  "project": {},
  "subject": "your_subject",
  "status": "inbox",
  "direction": "inbound",
  "end_time": "your_end_time",
  "lead": [],
  "internal_notes": "your_internal_notes",
  "phone_numbers": [],
  "custom_fields": {},
  "duration": "your_duration",
  "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",
        "engagements",
        "<resource_id>",
        {
        "engagement_type": "meeting",
        "content": "your_content",
        "contact": [],
        "start_time": "your_start_time",
        "created_at": "your_created_at",
        "owner": {},
        "account": {},
        "opportunity": [],
        "project": {},
        "subject": "your_subject",
        "status": "inbox",
        "direction": "inbound",
        "end_time": "your_end_time",
        "lead": [],
        "internal_notes": "your_internal_notes",
        "phone_numbers": [],
        "custom_fields": {},
        "duration": "your_duration",
        "remote_data": {}
},
        {"integrated_account_id": "<integrated_account_id>"}
    )
    print(result)

asyncio.run(main())