Create Engagement (Beta) — DevRev

Creates a new engagement record.

Request

This endpoint expects an object.

memberslist of stringsRequired

IDs of the users that were part of the engagement.

scheduled_datestringRequiredformat: "date-time"

The date and time when the engagement was scheduled.

titlestringRequiredformat: "text"

The title of the engagement.

artifactslist of stringsOptional

The IDs of the artifacts to associate with the engagement.

descriptionstringOptionalformat: "text"

The description of the engagement.

engagement_typeenumOptional

Allowed values: calldefaultemaillinked_inoffline

The type of engagement.

external_refstringOptionalformat: "text"

External Reference for the engagement.

external_urlstringOptionalformat: "text"

External URL for the engagement.

parentstringOptionalformat: "id"

The parent object ID in which the engagement was created. Currently, only accounts and opportunities are supported.

parentslist of stringsOptional

The parent object IDs to which the engagement is associated. Currently, only accounts and opportunities are supported.

tagslist of objectsOptional

Tags associated with the engagement.

Response

Success.

engagementobject

1 curl -X POST https://api.devrev.ai/engagements.create \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "members": [ 6 "members", 7 "members" 8 ], 9 "scheduled_date": "scheduled_date", 10 "title": "title" 11 }'

1 { 2 "engagement": { 3 "id": "id", 4 "created_by": { 5 "type": "dev_user", 6 "id": "id", 7 "display_id": "display_id", 8 "display_name": "display_name", 9 "display_picture": { 10 "id": "id", 11 "display_id": "display_id", 12 "file": {} 13 }, 14 "email": "email", 15 "full_name": "full_name", 16 "state": "active" 17 }, 18 "created_date": "created_date", 19 "description": "description", 20 "display_id": "display_id", 21 "modified_by": { 22 "type": "dev_user", 23 "id": "id", 24 "display_id": "display_id", 25 "display_name": "display_name", 26 "display_picture": { 27 "id": "id", 28 "display_id": "display_id", 29 "file": {} 30 }, 31 "email": "email", 32 "full_name": "full_name", 33 "state": "active" 34 }, 35 "modified_date": "modified_date" 36 } 37 }

1	curl -X POST https://api.devrev.ai/engagements.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"members": [
6	"members",
7	"members"
8	],
9	"scheduled_date": "scheduled_date",
10	"title": "title"
11	}'

1	{
2	"engagement": {
3	"id": "id",
4	"created_by": {
5	"type": "dev_user",
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name",
9	"display_picture": {
10	"id": "id",
11	"display_id": "display_id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"description": "description",
20	"display_id": "display_id",
21	"modified_by": {
22	"type": "dev_user",
23	"id": "id",
24	"display_id": "display_id",
25	"display_name": "display_name",
26	"display_picture": {
27	"id": "id",
28	"display_id": "display_id",
29	"file": {}
30	},
31	"email": "email",
32	"full_name": "full_name",
33	"state": "active"
34	},
35	"modified_date": "modified_date"
36	}
37	}