Create

POST

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_datedatetimeRequired

The date and time when the engagement was scheduled.

titlestringRequired

The title of the engagement.

artifactslist of stringsOptional

The IDs of the artifacts to associate with the engagement.

descriptionstringOptional

The description of the engagement.

engagement_typeenumOptional

Allowed values: calldefaultemaillinked_inoffline

The type of engagement.

external_refstringOptional

External Reference for the engagement.

external_urlstringOptional

External URL for the engagement.

parentstringOptional

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

This endpoint returns an object.

engagementobject

POST

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     "DEVU-12345"
7   ],
8   "scheduled_date": "2023-01-01T12:00:00Z",
9   "title": "title"
10 }'

200Successful

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

Built with

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	"DEVU-12345"
7	],
8	"scheduled_date": "2023-01-01T12:00:00Z",
9	"title": "title"
10	}'

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