Update

POST

Updates the engagement record.

Request

This endpoint expects an object.

idstringRequired

The engagement ID.

artifactsobjectOptional

descriptionstringOptional

Updates the description of the engagement.

external_refstringOptional

External Reference for the engagement.

external_urlstringOptional

Updates the external URL for the engagement.

membersobjectOptional

parentsobjectOptional

scheduled_datedatetimeOptional

Updates the date and time when the engagement was scheduled.

tagsobjectOptional

titlestringOptional

Updates the title of the engagement.

Response

This endpoint returns an object.

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": "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.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": "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	}