Update Engagement

POST

Updates the engagement record.

Request

This endpoint expects an object.

artifactsobjectRequired

idstringRequired

The engagement ID.

membersobjectRequired

parentsobjectRequired

tagsobjectRequired

descriptionstringOptional

Updates the description of the engagement.

external_refstringOptional

External Reference for the engagement.

external_urlstringOptional

Updates the external URL for the engagement.

scheduled_datestringOptionalformat: "date-time"

Updates the date and time when the engagement was scheduled.

titlestringOptional

Updates the title of the engagement.

Response

Success.

engagementobject

POST

1 curl -X POST https://api.devrev.ai/engagements.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "artifacts": {},
6   "id": "id",
7   "members": {},
8   "parents": {},
9   "tags": {}
10 }'

200Successful

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

Get Event Source

Up Next

Built with

1	curl -X POST https://api.devrev.ai/engagements.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"artifacts": {},
6	"id": "id",
7	"members": {},
8	"parents": {},
9	"tags": {}
10	}'

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