engagements

Update

POST
Updates the engagement record.

Request

This endpoint expects an object.
id
stringRequired
The engagement ID.
artifacts
objectOptional
description
stringOptional
Updates the description of the engagement.
external_ref
stringOptional
External Reference for the engagement.
external_url
stringOptional
Updates the external URL for the engagement.
members
objectOptional
scheduled_date
datetimeOptional
Updates the date and time when the engagement was scheduled.
tags
objectOptional
title
stringOptional
Updates the title of the engagement.

Response

This endpoint returns an object
engagement
object
POST
1curl -X POST https://api.devrev.ai/engagements.update \
2 -H "Authorization: <apiKey>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "id": "id"
6}'
200
Successful
1{
2 "engagement": {
3 "id": "id",
4 "created_date": "2023-01-01T12:00:00Z",
5 "description": "description",
6 "display_id": "display_id",
7 "modified_date": "2023-01-01T12:00:00Z"
8 }
9}