Skip to content

Create Engagements

Endpoint

http
POST /unified/crm/engagements
Integrations supported
  • Salesforce

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. Defaults to `unified`. `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.
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.
Example: remote_query[foo]=bar

Request Body

Refer Writing data using Unified APIs

subject
string
The engagement's subject
Supported in
  • Salesforce
content
string
The engagement's content
Supported in
  • Salesforce
engagement_type
string
The engagement's type
All possible enum values:
  • call
  • email
  • meeting
Enum support by integration
  • Salesforce
    • call
    • email
    • meeting
Required in
  • Salesforce
contact
object[]
The engagement's contacts
Supported in
  • Salesforce
id
string
The contact's unique identifier
owner
object
The engagement's owner
Supported in
  • Salesforce
id
string
The owner's unique identifier
start_time
string · date-time
The engagement's start time. Only applicable when engagement_type is meeting.
Supported in
  • Salesforce
end_time
string · date-time
The engagement's end time. Only applicable when engagement_type is meeting.
Supported in
  • Salesforce
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
string[]
The engagement's opportunity
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.