DROP Management

Update DROP Record

Use this API to update the status and/or data subject access request ID of an existing DROP record.

put/api/drop-manager/v1/drop/{dropId}

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/drop-manager/v1/drop/{dropId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: DSAR_WRITE

Path parameters

dropIdstring required

DROP record identifier

Request body

status'PENDING' | 'EXEMPTED' | 'DELETED' | 'OPTED_OUT' | 'NOT_FOUND'

DROP status to update. Valid values: PENDING, EXEMPTED, DELETED, OPTED_OUT, NOT_FOUND. The status must be different from the current status.

dsarRequestIdstring uuid

DSAR request ID to link with the DROP record. Used to associate the DROP with a DSAR request.

Example request

{
  "status": "DELETED",
  "dsarRequestId": "e2d0f59e-3df0-4b1f-965d-d57547ed44ad"
}

Response

OK

Changes

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