Appearance

Update Engagements ​

Endpoint ​

http
PATCH /unified/crm/engagements/{id}
Integrations supported
  • HubSpot
  • Salesforce

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

Request Body ​

Refer Writing data using Unified APIs

owner
object

The engagement's owner

Supported in
  • HubSpot
  • Salesforce
id
string

The owner's unique identifier

content
string

The engagement's content

Supported in
  • HubSpot
  • Salesforce
subject
string

The engagement's subject

Supported in
  • HubSpot
  • Salesforce
direction
string

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

All possible enum values:
  • inbound
  • outbound
Enum support by integration
  • HubSpot
    • inbound
    • outbound
Supported in
  • HubSpot
engagement_type
string

The engagement's type

All possible enum values:
  • call
  • email
  • meeting
  • call
  • email
  • meeting
Enum support by integration
  • HubSpot
    • call
    • email
    • meeting
  • Salesforce
    • call
    • email
    • meeting
Required in
  • HubSpot
  • Salesforce
start_time
string · date-time

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

Supported in
  • HubSpot
  • Salesforce
end_time
string · date-time

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

Supported in
  • HubSpot
  • Salesforce
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • HubSpot
contact
object[]

The engagement's contacts

Supported in
  • Salesforce
id
string

The contact's unique identifier

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 engagement's unique identifier

owner
object

The engagement's owner

id
string

The owner's unique identifier

content
string

The engagement's content

subject
string

The engagement's subject

direction
string

The engagement's direction

engagement_type
string

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

start_time
string · date-time

The engagement's start time

end_time
string · date-time

The engagement's end time

account
object

The engagement's account

id
string

The account's unique identifier

contact
object[]

The engagement's contacts

id
string

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

id
string

The opportunity's unique identifier

created_at
string · date-time

The date and time of the engagement's creation

updated_at
string · date-time

The date and time of the engagement's last update

remote_data
object

Raw data returned from the remote API call.