Delete Engagements ​
Endpoint ​
DELETE /unified/crm/engagements/{id}
Integrations supported
- Affinity
- Freshsales
- Pipeliner
- Planhat
- Zendesk Sell
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
The engagement's type - call, email, meeting or raw response
call
chat
email
meeting
Enum support by integration
- Affinity
call
email
meeting
chat
- Pipeliner
call
email
Required in
- Affinity
- Pipeliner
The field to sort the resource by. Should be in format { fieldName: direction }
. The direction can be asc
or desc
.
created_at
updated_at
Supported in
- Pipeliner
Set this value only when engagement type is email.
Supported in
- Pipeliner
Set this value only when engagement type is email.
Supported in
- Pipeliner
Set this value only when engagement type is email.
Supported in
- Pipeliner
The date and time of the engagement's creation
Supported in
- Pipeliner
The date and time of the engagement's last update
Supported in
- Pipeliner
The engagement's status
Supported in
- Pipeliner
The engagement's account
Supported in
- Pipeliner
The account's unique identifier
The engagement's contacts
Supported in
- Pipeliner
Response Body ​
The engagement's unique identifier
Supported in
- Pipeliner
- Planhat
The engagement's owner
Supported in
- Planhat
The owner's unique identifier
The engagement's content
Supported in
- Planhat
The engagement's subject
Supported in
- Planhat
The engagement's direction
The engagement's type - call, email, meeting or raw response
Supported in
- Planhat
The engagement's internal notes
The engagement's notes
The note's unique identifier
The engagement's status
Supported in
- Planhat
The engagement's start time
Supported in
- Planhat
The engagement's end time
The engagement's duration
The engagement's project
The project's unique identifier
The engagement's account
Supported in
- Planhat
The account's unique identifier
The engagement's contacts
Supported in
- Planhat
The contact's unique identifier
The engagement's opportunity
The opportunity's unique identifier
The engagement's lead
The lead's unique identifier
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
- Planhat
The date and time of the engagement's last update
Raw data returned from the remote API call.