Update Engagements ​
Endpoint ​
PATCH /unified/crm/engagements/{id}
Integrations supported
- Affinity
- Capsule
- Close
- Freshsales
- HubSpot
- Pipedrive
- Planhat
- Salesforce
- Zendesk Sell
- Zoho CRM
Path parameters ​
The ID of the resource.
23423523
Query parameters ​
Refer Specifying query parameters in Truto APIs
The ID of the integrated account to use for the request.
62f44730-dd91-461e-bd6a-aedd9e0ad79d
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
.
unified
raw
normalized
unified
Excludes the remote_data
attribute from the response.
Array of fields to exclude from the response.
truto_exclude_fields[]=id&truto_exclude_fields[]=name
Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.
remote_query[foo]=bar
Request Body ​
Refer Writing data using Unified APIsThe engagement's type
call
note
email
meeting
chat
Enum support by integration
- Close
call
note
email
- HubSpot
call
email
meeting
- Salesforce
call
email
meeting
- Zoho CRM
call
meeting
- Affinity
meeting
call
chat
Required in
- Affinity
- Close
- HubSpot
- Salesforce
- Zoho CRM
Supported in
- Pipedrive
- Planhat
The engagement's content
Required in
- Capsule
Supported in
- Affinity
- Close
- HubSpot
- Pipedrive
- Planhat
- Salesforce
- Zoho CRM
The engagement's subject
Supported in
- Close
- Freshsales
- HubSpot
- Pipedrive
- Planhat
- Salesforce
- Zendesk Sell
- Zoho CRM
Status associated with the engagement.
inbox
draft
scheduled
outbox
sent
Enum support by integration
- Close
inbox
draft
scheduled
outbox
sent
Supported in
- Close
The engagement's direction. Specify only if engagement_type is call
inbound
outbound
Enum support by integration
- HubSpot
inbound
outbound
Supported in
- Close
- HubSpot
The engagement's account
Supported in
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
The account's unique identifier
The engagement's start time. Only applicable when engagement_type is meeting.
Supported in
- Affinity
- Close
- Freshsales
- HubSpot
- Salesforce
- Zoho CRM
The engagement's end time. Only applicable when engagement_type is meeting.
Supported in
- Close
- Freshsales
- HubSpot
- Salesforce
- Zoho CRM
Supported in
- Close
The engagement's owner
Supported in
- Capsule
- Freshsales
- HubSpot
- Pipedrive
- Planhat
- Salesforce
- Zendesk Sell
- Zoho CRM
The owner's unique identifier
The engagement's internal notes
Supported in
- HubSpot
The date and time of the engagement's creation
Supported in
- Affinity
- HubSpot
The engagement's contacts
Required in
- Affinity
Supported in
- Capsule
- Freshsales
- Pipedrive
- Planhat
- Salesforce
- Zendesk Sell
- Zoho CRM
The contact's unique identifier
The engagement's opportunity
Supported in
- Capsule
- Freshsales
- Pipedrive
The opportunity's unique identifier
The engagement's lead
Supported in
- Salesforce
- Zendesk Sell
The lead's unique identifier
The engagement's duration
Supported in
- Salesforce
- Zendesk Sell
- Zoho CRM
Supported in
- Freshsales
The engagement's project
Supported in
- Capsule
The project's unique identifier
Supported in
- Zendesk Sell
The unique identifier of the phone number
The phone number
The extension of the phone number
The phone number type
All the custom fields present on the engagement
Supported in
- Planhat
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 ​
The engagement's unique identifier
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zendesk Sell
- Zoho CRM
The engagement's owner
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zendesk Sell
- Zoho CRM
The owner's unique identifier
The engagement's content
Supported in
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zoho CRM
The engagement's subject
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zendesk Sell
- Zoho CRM
The engagement's direction
Supported in
- Close
- Zoho CRM
The engagement's type - call, email, meeting or raw response
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zendesk Sell
- Zoho CRM
The engagement's internal notes
The engagement's notes
Supported in
- Affinity
The note's unique identifier
The engagement's status
Supported in
- Capsule
- Close
- Planhat
The engagement's start time
Supported in
- Affinity
- Close
- Freshsales
- Planhat
- Zendesk Sell
- Zoho CRM
The engagement's end time
Supported in
- Affinity
- Close
- Freshsales
- Zoho CRM
The engagement's duration
Supported in
- Zendesk Sell
- Zoho CRM
The engagement's project
Supported in
- Capsule
The project's unique identifier
The engagement's account
Supported in
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
The account's unique identifier
The engagement's contacts
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zendesk Sell
- Zoho CRM
The contact's unique identifier
The engagement's opportunity
Supported in
- Capsule
- Freshsales
- Pipedrive
- Zendesk Sell
The opportunity's unique identifier
The engagement's lead
Supported in
- Zendesk Sell
The lead's unique identifier
Supported in
- Zendesk Sell
The unique identifier of the phone number
The phone number
The extension of the phone number
The phone number type
All the custom fields present on the engagement
Supported in
- Planhat
The date and time of the engagement's creation
Supported in
- Affinity
- Capsule
- Close
- Freshsales
- Pipedrive
- Planhat
- Zoho CRM
The date and time of the engagement's last update
Supported in
- Capsule
- Close
- Freshsales
- Pipedrive
- Zendesk Sell
- Zoho CRM
Raw data returned from the remote API call.