ONonetrust
Engagements

Update Engagement Status

Use this API to update the status of an existing engagement.

put/api/vendor/v1/engagements/{engagementId}/status

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/vendor/v1/engagements/{engagementId}/status
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: GENERIC, VRM

Path parameters

engagementIdstring uuid required
Example:41aa71ae-0ace-4073-8947-e6941714bcf1

The unique identifier of an engagement. The value can be obtained using the Get Engagements API.

Request body

status'ACTIVE' | 'PENDING' | 'ARCHIVED' required

The new status for the engagement.

Example request

{
  "status": "ACTIVE"
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.