OSosano
dsar

Update Subject Rights Request

Update metadata about a Subject Rights Request as specified. A partial update may be performed.

patch/v1/subject-rights/requests/{dsarId}

Request

Path parameters

dsarIdstring required

The identifier of the Subject Rights Request to be updated.

Request body

status'PENDING_EMAIL_VERIFICATION' | 'PENDING_IDENTITY_VERIFICATION' | 'IN_PROGRESS' | 'PENDING_APPEAL' | 'COMPLETED' | 'REJECTED' | 'REJECTED_AUTO' | 'IN_REVIEW'
notesstring
notifyboolean

When set to true and status is COMPLETED or REJECTED, an email notification will be sent to the requestor. Defaults to true when status is COMPLETED or REJECTED, otherwise defaults to false.

contentstring nullable

Optional completion or rejection message to be emailed to the requestor. When status is COMPLETED or REJECTED, this message will be used as the completionMessage or rejectionReason in the notification. If omitted, the email notification handler will use a configured template. This message will be added to the portal conversation.

rejectionReasonCode'TECHNICALLY_INFEASIBLE' | 'REJECTED_APPEAL' | 'UNCOVERED_GEO' | 'DUPLICATE' | 'UNFOUNDED' | 'OTHER' | 'IDENTITY_NOT_VERIFIED'

Optional rejection reason code. Only applicable when status is REJECTED. Used to select a specific rejection template for the notification email.

Response

Success

dsarIdstring required
statusstring required
requestTypestring required
requestSourcestring required
notesstring
dsarDetailsobject
duestring date-time required
createdstring date-time required
isTestboolean required

True if this is a test Subject Rights Request. Test requests are excluded from reporting. This value is read-only and cannot be set or changed through the API.

Changes

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