Create a redaction job Preview

POST / v1 / privacy / redaction_jobs

Creates a redaction job. When a job is created, it will start to validate.

Parameters

• objects object Required The objects to redact. These root objects and their related ones will be validated for redaction.
• validation _ behavior enum Determines the validation behavior of the job. Default is error. Possible enum values error The job will generate a validation error for every object that cannot be redacted. If there are any errors, all of them will need to be resolved before the job can run. fix The job will attempt to fix validation errors whenever possible. Some objects cannot be automatically fixed and will need to be resolved before the job can run.

Returns

Returns the newly created RedactionJob object.

Response

{ "id": "prj_123", "object": "privacy.redaction_job", "created": 1234567890, "livemode": true, "status": "validating", "validation_behavior": "error"}

Update a redaction job Preview

POST / v1 / privacy / redaction_jobs /:id

Updates the properties of a redaction job without running or canceling the job.

If the job to update is in a failed status, it will not automatically start to validate. Once you applied all of the changes, use the validate API to start validation again.

Parameters

• job string Required RedactionJob object identifier
• validation _ behavior enum Determines the validation behavior of the job. Default is error. Possible enum values error The job will generate a validation error for every object that cannot be redacted. If there are any errors, all of them will need to be resolved before the job can run. fix The job will attempt to fix validation errors whenever possible. Some objects cannot be automatically fixed and will need to be resolved before the job can run.

Returns

Returns the RedactionJob object with the updated changes.

Response

{ "id": "prj_123", "object": "privacy.redaction_job", "created": 1234567890, "livemode": true, "status": "failed", "validation_behavior": "fix"}

Retrieve a redaction job Preview

GET / v1 / privacy / redaction_jobs /:id

Retrieves the details of a previously created redaction job.

Parameters

• job string Required RedactionJob object identifier

Returns

Returns the RedactionJob object.

Response

{ "id": "prj_123", "object": "privacy.redaction_job", "created": 1234567890, "livemode": true, "status": "ready", "validation_behavior": "error"}