Appearance

Update Engagements ​

Endpoint ​

http
PATCH /unified/crm/engagements/{id}
Integrations supported
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM

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

engagement_type
string

The engagement's type

All possible enum values:
  • call
  • note
  • email
  • meeting
  • chat
Enum support by integration
  • Close
    • call
    • note
    • email
  • HubSpot
    • call
    • email
    • meeting
  • Salesforce
    • call
    • email
    • meeting
  • Zoho CRM
    • call
    • meeting
  • Affinity
    • meeting
    • call
    • chat
Required in
  • Affinity
  • Close
  • HubSpot
  • Salesforce
  • Zoho CRM
Supported in
  • Pipedrive
  • Planhat
content
string

The engagement's content

Required in
  • Capsule
Supported in
  • Affinity
  • Close
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zoho CRM
subject
string

The engagement's subject

Supported in
  • Close
  • Freshsales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
status
string

Status associated with the engagement.

All possible enum values:
  • inbox
  • draft
  • scheduled
  • outbox
  • sent
Enum support by integration
  • Close
    • inbox
    • draft
    • scheduled
    • outbox
    • sent
Supported in
  • Close
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
  • Close
  • HubSpot
account
object

The engagement's account

Supported in
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
id
string

The account's unique identifier

start_time
string · data-time

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

Supported in
  • Affinity
  • Close
  • Freshsales
  • HubSpot
  • Salesforce
  • Zoho CRM
end_time
string · date-time

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

Supported in
  • Close
  • Freshsales
  • HubSpot
  • Salesforce
  • Zoho CRM
date_created
Supported in
  • Close
owner
object

The engagement's owner

Supported in
  • Capsule
  • Freshsales
  • HubSpot
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string

The owner's unique identifier

internal_notes
string

The engagement's internal notes

Supported in
  • HubSpot
created_at
string · data-time

The date and time of the engagement's creation

Supported in
  • Affinity
  • HubSpot
contact
object[]

The engagement's contacts

Required in
  • Affinity
Supported in
  • Capsule
  • Freshsales
  • Pipedrive
  • Planhat
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
id
string
REQUIRED · 

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

Supported in
  • Capsule
  • Freshsales
  • Pipedrive
id
string

The opportunity's unique identifier

lead
object[]

The engagement's lead

Supported in
  • Salesforce
  • Zendesk Sell
id
string

The lead's unique identifier

duration
string

The engagement's duration

Supported in
  • Salesforce
  • Zendesk Sell
  • Zoho CRM
description
Supported in
  • Freshsales
project
object

The engagement's project

Supported in
  • Capsule
id
string

The project's unique identifier

phone_numbers
object[]
Supported in
  • Zendesk Sell
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
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

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zendesk Sell
  • Zoho CRM
owner
object

The engagement's owner

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zendesk Sell
  • Zoho CRM
id
string

The owner's unique identifier

content
string

The engagement's content

Supported in
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zoho CRM
subject
string

The engagement's subject

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zendesk Sell
  • Zoho CRM
direction
string

The engagement's direction

Supported in
  • Close
  • Zoho CRM
engagement_type
string

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

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zendesk Sell
  • Zoho CRM
internal_notes
string

The engagement's internal notes

notes
object[]

The engagement's notes

Supported in
  • Affinity
id
string

The note's unique identifier

status
string

The engagement's status

Supported in
  • Capsule
  • Close
  • Planhat
start_time
string · date-time

The engagement's start time

Supported in
  • Affinity
  • Close
  • Freshsales
  • Planhat
  • Zendesk Sell
  • Zoho CRM
end_time
string · date-time

The engagement's end time

Supported in
  • Affinity
  • Close
  • Freshsales
  • Zoho CRM
duration
string

The engagement's duration

Supported in
  • Zendesk Sell
  • Zoho CRM
project
object

The engagement's project

Supported in
  • Capsule
id
string

The project's unique identifier

account
object

The engagement's account

Supported in
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zoho CRM
id
string

The account's unique identifier

contact
object[]

The engagement's contacts

Supported in
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zendesk Sell
  • Zoho CRM
id
string

The contact's unique identifier

opportunity
object[]

The engagement's opportunity

Supported in
  • Capsule
  • Freshsales
  • Pipedrive
  • Zendesk Sell
  • Zoho CRM
id
string

The opportunity's unique identifier

lead
object[]

The engagement's lead

Supported in
  • Zendesk Sell
  • Zoho CRM
id
string

The lead's unique identifier

phone_numbers
object[]
Supported in
  • Zendesk Sell
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
  • Affinity
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Planhat
  • Zoho CRM
updated_at
string · date-time

The date and time of the engagement's last update

Supported in
  • Capsule
  • Close
  • Freshsales
  • Pipedrive
  • Zendesk Sell
  • Zoho CRM
remote_data
object

Raw data returned from the remote API call.