POST api/people/{id}/redact?note={note}&sendEmail={sendEmail}

Redact a Person by PersonId First request is just logged as an event Second request must be by a branch admin and actually redacts the person Only set sendEmail to false for internal bulk redact requests, the normal process requires an email. This will also suppress notifications to the negotiator.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

note

string

Default value is

sendEmail

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

Details of the redation job

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

boolean

None.

ReportsProgress

boolean

None.

InitialStatusText

string

None.

JobReference

globally unique identifier

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "52923bd3-ba5d-4d96-8aee-440745355ea5",
  "Success": true
}