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

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

200Successful

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 }

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

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	}