Create an Engagement

Logs a new engagement such as a call, email, or meeting against a CRM record.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Supported apps for Create Engagement

Affinity (affinity)

Supported Request Fields:

  • type - Required
  • content - Required
  • startDateTime - Required
  • direction

Additional Metadata:

  • contactIds - Required

Supported Response Fields:

  • id
Close CRM (close-crm)

Supported Request Fields:

  • type
  • subject
  • direction
  • content
  • startDateTime
  • endDateTime
  • channel
  • owner.id
  • owner.email
  • customFields
HubSpot (hubspot)

Supported Request Fields:

  • type - Required
  • subject
  • direction
  • content
  • owner.id
  • owner.email
  • startDateTime
  • endDateTime
  • channel
  • status
  • customFields

Additional Metadata:

  • metadata.associations
  • metadata.accountId
  • metadata.contactId
  • metadata.contactIds
  • metadata.dealId

Supported Response Fields:

  • id
Salesforce (salesforce)

Supported Request Fields:

  • type - Required
  • subject
  • direction
  • content
  • owner.id
  • startDateTime
  • endDateTime
  • status
  • customFields

Additional Metadata:

  • metadata.accountId
  • metadata.contactId
  • metadata.dealId

Supported Response Fields:

  • id
Sugar CRM (sugar-crm)

Supported Request Fields:

  • type - Required
  • subject
  • direction
  • content
  • owner.id
  • startDateTime - Required
  • endDateTime - Required
  • customFields
  • metadata

Additional Metadata:

  • fromEmailAddress
  • toEmailAddress

Supported Response Fields:

  • id
Zendesk CRM (zendesk-crm)

Supported Request Fields:

  • type - Required
  • subject
  • direction
  • content
  • owner.id
  • startDateTime
  • endDateTime
  • status
  • channel

Additional Metadata:

  • metadata.resourceType - Required
  • metadata.resourceId - Required

Supported Response Fields:

  • id
Zoho CRM (zoho-crm)

Supported Request Fields:

  • type - Required
  • subject
  • direction
  • content
  • owner.id
  • owner.email
  • startDateTime
  • endDateTime
  • customFields

Additional Metadata:

  • metadata.call.duration
  • metadata.accountId
  • metadata.contactId
  • metadata.dealId

Supported Response Fields:

  • id
Brevo (brevo)

Supported Request Fields:

  • type - Required
  • content - Required (for NOTE type)
  • subject - Required (for TASK type)
  • endDateTime - Required (for TASK type)
  • owner.id
  • customFields

Additional Metadata:

Supported Response Fields:

  • id
Pipeline CRM (pipelinecrm)
Attio (attio)

Supported Request Fields:

  • type - Required - one of NOTE TASK

for type NOTE

  • subject - Required
  • content - Required
  • customFields

Additional Metadata:

  • metadata.parent_object - Required - the object to which the note belongs to. Example : people, companies etc.
  • metadata.parent_record_id - Required - the object id to which the note belongs to.
  • metadata.format - Required - format of the note content, one of plaintext, markdown

for type TASK

  • content - Required
  • customFields

Additional Metadata:

  • metadata.deadline_at - Required - The deadline of the task, in ISO 8601 format. Example: '2023-01-01T15:00:00.000000000Z' .
  • metadata.is_completed - Required - boolean value - Whether the task has been completed.
  • metadata.format - Required - format of the task content, one of plaintext, markdown
  • metadata.linked_records - Required - An array of email addresses and/or company website domains. Email addresses are matched to person records via the email_addresses attribute; domains are matched to company records via the domains attribute. An email address or company website domain. Example: ["[email protected]", "fundstack.com"]
  • metadata.assignees - Required - An Array of email_addresses or user ids to whom this task is being assigned.If you are giving user ids - the object inside array should be like {referenced_actor_type: workspace-member, referenced_actor_id: d76621d4-9017-4cb5-953f-4f990d06ddb7} else { workspace_member_email_address : [email protected] }

Supported Response Fields:

  • id
Microsoft Dynamics 365 Sales (msd-365-sales)

Supported Request Fields:

  • type - Required
  • subject
  • direction - only supported for types CALL, EMAIL
  • content
  • owner.id
  • startDateTime - not supported for type NOTE
  • endDateTime - not supported for type NOTE
  • customFields
  • metadata

Supported Response Fields:

  • id
Body Params
string
enum
Allowed:
string
string
enum
Allowed:
string
owner
object
date
date
string

The communication channel. Applicable for type COMMUNICATION

json

A JSON of fieldId, value pair. Example: {"field1":"value1","field2":"value2"}

json
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json