engagements

Create

POST
Creates a new engagement record.

Request

This endpoint expects an object.
members
list of stringsRequired
IDs of the users that were part of the engagement.
parent
stringRequired
The parent object ID in which the engagement was created. Currently, only accounts and opportunities are supported.
scheduled_date
datetimeRequired
The date and time when the engagement was scheduled.
title
stringRequired
The title of the engagement.
artifacts
list of stringsOptional
The IDs of the artifacts to associate with the engagement.
description
stringOptional
The description of the engagement.
engagement_type
enumOptional
The type of engagement.
Allowed values: calldefaultemaillinked_inoffline
external_ref
stringOptional
External Reference for the engagement.
external_url
stringOptional
External URL for the engagement.
tags
list of objectsOptional
Tags associated with the engagement.

Response

This endpoint returns an object
engagement
object
POST
1curl -X POST https://api.devrev.ai/engagements.create \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "members": [
6 "DEVU-12345"
7 ],
8 "parent": "ACC-12345",
9 "scheduled_date": "2023-01-01T12:00:00Z",
10 "title": "title"
11}'
200
Successful
1{
2 "engagement": {
3 "id": "id",
4 "created_date": "2023-01-01T12:00:00Z",
5 "description": "description",
6 "display_id": "display_id",
7 "modified_date": "2023-01-01T12:00:00Z"
8 }
9}