Update Engagement

POST

Updates the engagement record.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The engagement ID.

artifactsobjectOptional

descriptionstringOptionalformat: "text"

Updates the description of the engagement.

external_refstringOptionalformat: "text"

External Reference for the engagement.

external_urlstringOptionalformat: "text"

Updates the external URL for the engagement.

membersobjectOptional

parentsobjectOptional

scheduled_datestringOptionalformat: "date-time"

Updates the date and time when the engagement was scheduled.

tagsobjectOptional

titlestringOptionalformat: "text"

Updates the title of the engagement.

Response

Success.

engagementobject

Errors

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   "id": "foo"
6 }'

200engagementsUpdateExample

1 {
2   "engagement": {
3     "id": "foo",
4     "created_by": {
5       "display_id": "foo",
6       "id": "foo",
7       "display_name": "foo",
8       "display_picture": {
9         "display_id": "foo",
10         "id": "foo",
11         "file": {
12           "type": "foo",
13           "name": "foo",
14           "size": 42
15         }
16       },
17       "email": "foo",
18       "full_name": "foo",
19       "state": "active"
20     },
21     "created_date": "2023-01-01T12:00:00.000Z",
22     "description": "foo",
23     "display_id": "foo",
24     "modified_by": {
25       "display_id": "foo",
26       "id": "foo",
27       "display_name": "foo",
28       "display_picture": {
29         "display_id": "foo",
30         "id": "foo",
31         "file": {
32           "type": "foo",
33           "name": "foo",
34           "size": 42
35         }
36       },
37       "email": "foo",
38       "full_name": "foo",
39       "state": "active"
40     },
41     "modified_date": "2023-01-01T12:00:00.000Z"
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	"id": "foo"
6	}'

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