Create Engagements
/unified/crm/engagements
Query Parameters
Refer Specifying query parameters in Truto APIs
The engagement's type
callmeeting
2 supported2 required
Show Truto-specific parameters
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79dThe format of the response.
unifiedreturns the response with unified mappings applied.rawreturns the unprocessed, raw response from the remote API.normalizedapplies the unified mappings and returns the data in a normalized format.streamreturns 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.debugreturns the final unified result alongside raw remote fetch information. The response is an envelope containingresult(identical to unified mode output) anddebug(withrequestUrl,requestOptions,data,responseHeaders, and for list operations:nextCursor,isLooping,isEmptyResult,resultCount).debugisnullfor static responses or whentruto_skip_api_call=true.
Defaults to unified.
unifiedunifiedrawnormalizedstreamdebug
Excludes the remote_data attribute from the response.
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.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=nameQuery parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=barRequest Body
Refer Writing data using Unified APIs
The engagement's account
7 supported1 required
The account's unique identifier
The engagement's contacts
11 supported2 required
The contact's unique identifier
1 supported
The engagement's content
9 supported3 required
The date and time of the engagement's creation
11 supported1 required
All the custom fields present on the engagement
2 supported
1 supported
1 supported
The engagement's direction. Specify only if engagement_type is call
inboundoutboundoutboundinboundmissed
2 supported
outboundinboundmissedDuration of the engagement.
3 supported
The engagement's end time. Only applicable when engagement_type is meeting.
5 supported1 required
The engagement's type
meetingcallchatcallmeetingnotecallnoteemailmeetingcallemailmeetingcallemailmeetingcallmeeting+ 6 more
14 supported6 required
meetingcallchatcallnoteemailcallemailmeetingcallemailmeetingcallmeetingcallmeetingnotemeetingThe engagement's internal notes.
Leads associated with the engagement.
3 supported
The unique identifier of the Lead.
The engagement's notes
1 supported
The note's unique identifier
The engagement's opportunity
6 supported
The opportunity's unique identifier
The engagement's owner
10 supported
The owner's unique identifier
Set this value only when engagement type is call.
2 supported1 required
The extension of the phone number
The unique identifier of the phone number
The phone number
The phone number type
Project associated with the note
1 supported
The unique identifier of the project.
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.
The engagement's start time. Only applicable when engagement_type is meeting.
7 supported1 required
Status associated with the engagement.
inboxdraftscheduledoutboxsent
5 supported
inboxdraftscheduledoutboxsentThe engagement's subject
9 supported2 required
1 supported
Response Body
The engagement's unique identifier
12 supported
The engagement's account
7 supported
The account's unique identifier
The engagement's contacts
11 supported
The contact's unique identifier
The engagement's content
8 supported
The date and time of the engagement's creation
10 supported
All the custom fields present on the engagement
2 supported
The engagement's direction
2 supported
The engagement's duration
3 supported
The engagement's end time
5 supported
The engagement's type - call, email, meeting or raw response
12 supported
The engagement's internal notes
The engagement's lead
3 supported
The lead's unique identifier
The engagement's notes
1 supported
The note's unique identifier
The engagement's opportunity
6 supported
The opportunity's unique identifier
The result of the engagement. For calls, this is the call disposition (for example, connected, no_answer, left_voicemail, busy, wrong_number). For meetings, this is the meeting outcome (for example, completed, no_show, rescheduled, canceled). Values are normalized to lowercase snake_case where possible; provider-specific labels may be returned when no standard mapping exists.
The engagement's owner
10 supported
The owner's unique identifier
2 supported
The extension of the phone number
The unique identifier of the phone number
The phone number
The phone number type
The engagement's project
1 supported
The project's unique identifier
A URL to access the call or meeting recording when available from the CRM. May be a direct media URL or a CRM-hosted review page, depending on the provider.
Raw data returned from the remote API call.
The engagement's start time
7 supported
The engagement's status
5 supported
The engagement's subject
9 supported
The full text transcript of the call or meeting when available from the CRM. Structured or speaker-segmented transcripts are flattened to plain text in this field.
The date and time of the engagement's last update
9 supported
truto unified crm engagements \
-m create \
-a '<integrated_account_id>' \
-b '{
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"remote_data": {}
}' \
-o jsonimport Truto from '@truto/truto-ts-sdk';
const truto = new Truto({
token: '<your_api_token>',
});
const result = await truto.unifiedApi.create(
'crm',
'engagements',
{
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"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",
"engagements",
{
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"remote_data": {}
},
{"integrated_account_id": "<integrated_account_id>"}
)
print(result)
asyncio.run(main())curl -X POST 'https://api.truto.one/unified/crm/engagements?integrated_account_id=<integrated_account_id>' \
-H 'Authorization: Bearer <your_api_token>' \
-H 'Content-Type: application/json' \
-d '{
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"remote_data": {}
}'const integratedAccountId = '<integrated_account_id>';
const body = {
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"remote_data": {}
};
const response = await fetch(`https://api.truto.one/unified/crm/engagements?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/engagements"
headers = {
"Authorization": "Bearer <your_api_token>",
"Content-Type": "application/json",
}
params = {
"integrated_account_id": "<integrated_account_id>"
}
payload = {
"engagement_type": "meeting",
"content": "your_content",
"owner": {},
"contact": [],
"start_time": "your_start_time",
"created_at": "your_created_at",
"account": {},
"opportunity": [],
"project": {},
"subject": "your_subject",
"status": "inbox",
"direction": "inbound",
"end_time": "your_end_time",
"lead": [],
"internal_notes": "your_internal_notes",
"notes": [],
"duration": "your_duration",
"phone_numbers": [],
"custom_fields": {},
"user_id": "your_user_id",
"remote_data": {}
}
response = requests.post(url, headers=headers, params=params, json=payload)
print(response.json())