Skip to main content
POST
Create Engagement

Authorizations

x-api-key
string
header
required
x-api-secret
string
header
required
x-connector-id
string
header
required
x-owner-id
string
header
required
x-session-token
string
header
required

Query Parameters

returnResource
default:false

Body

type
enum<string>
required

Type of engagement

Available options:
call,
meeting,
email,
task,
note
startedAt
string<date-time>
required

Start time in ISO 8601 format

direction
enum<string>

Direction of the engagement

Available options:
inbound,
outbound
status
enum<string>

Engagement status

Available options:
planned,
inProgress,
completed,
canceled
title
string

Subject or title of the engagement

description
string

Engagement content details

endedAt
string<date-time>

End time in ISO 8601 format

duration
integer

Duration in seconds

Required range: x >= 0
owner
object

Owner of the engagement

users
object[]

Related users

companies
object[]

Related companies

contacts
object[]

Related contacts

opportunities
object[]

Related opportunities

Response

Created

object
enum<string>
default:resource
required
Available options:
resourceRef
model
string
required
id
string
required
remote
object