Update Engagements ​
Endpoint ​
PATCH /unified/crm/engagements/{id}
Integrations supported
- HubSpot
- Salesforce
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 owner
Supported in
- HubSpot
- Salesforce
The owner's unique identifier
The engagement's content
Supported in
- HubSpot
- Salesforce
The engagement's subject
Supported in
- HubSpot
- Salesforce
The engagement's direction. Specify only if engagement_type is call
inbound
outbound
Enum support by integration
- HubSpot
inbound
outbound
Supported in
- HubSpot
The engagement's type
call
email
meeting
call
email
meeting
Enum support by integration
- HubSpot
call
email
meeting
- Salesforce
call
email
meeting
Required in
- HubSpot
- Salesforce
The engagement's start time. Only applicable when engagement_type is meeting.
Supported in
- HubSpot
- Salesforce
The engagement's end time. Only applicable when engagement_type is meeting.
Supported in
- HubSpot
- Salesforce
The date and time of the engagement's creation
Supported in
- HubSpot
The engagement's contacts
Supported in
- Salesforce
The contact's unique identifier
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
The engagement's owner
The owner's unique identifier
The engagement's content
The engagement's subject
The engagement's direction
The engagement's type - call, email, meeting or raw response
The engagement's start time
The engagement's end time
The engagement's account
The account's unique identifier
The engagement's contacts
The contact's unique identifier
The engagement's opportunity
The opportunity's unique identifier
The date and time of the engagement's creation
The date and time of the engagement's last update
Raw data returned from the remote API call.