Appearance

Delete Engagements ​

Endpoint ​

http
DELETE /unified/crm/engagements/{id}
Integrations supported
  • Affinity
  • Freshsales
  • Pipeliner
  • Planhat
  • Zendesk Sell

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
engagement_type
string

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

All possible enum values:
  • call
  • chat
  • email
  • meeting
Enum support by integration
  • Affinity
    • call
    • email
    • meeting
    • chat
  • Pipeliner
    • call
    • email
Required in
  • Affinity
  • Pipeliner
sort_by

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

All possible enum values:
  • created_at
  • updated_at
Supported in
  • Pipeliner
content
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
subject
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
direction
string

Set this value only when engagement type is email.

Supported in
  • Pipeliner
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Pipeliner
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Pipeliner
status
string

The engagement's status

Supported in
  • Pipeliner
account
object

The engagement's account

Supported in
  • Pipeliner
id
string

The account's unique identifier

contact
array

The engagement's contacts

Supported in
  • Pipeliner

Response Body ​

id
string
REQUIRED · 

The engagement's unique identifier

Supported in
  • Pipeliner
  • Planhat
owner
object

The engagement's owner

Supported in
  • Planhat
id
string

The owner's unique identifier

content
string

The engagement's content

Supported in
  • Planhat
subject
string

The engagement's subject

Supported in
  • Planhat
direction
string

The engagement's direction

engagement_type
string

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

Supported in
  • Planhat
internal_notes
string

The engagement's internal notes

notes
object[]

The engagement's notes

id
string

The note's unique identifier

status
string

The engagement's status

Supported in
  • Planhat
start_time
string · date-time

The engagement's start time

Supported in
  • Planhat
end_time
string · date-time

The engagement's end time

duration
string

The engagement's duration

project
object

The engagement's project

id
string

The project's unique identifier

account
object

The engagement's account

Supported in
  • Planhat
id
string

The account's unique identifier

contact
object[]

The engagement's contacts

Supported in
  • Planhat
id
string

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

id
string

The opportunity's unique identifier

lead
object[]

The engagement's lead

id
string

The lead's unique identifier

phone_numbers
object[]
id
string

The unique identifier of the phone number

number
string

The phone number

extension
string

The extension of the phone number

type
string

The phone number type

custom_fields
object

All the custom fields present on the engagement

Supported in
  • Planhat
created_at
string · date-time

The date and time of the engagement's creation

Supported in
  • Planhat
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.