The Redaction Job object Preview

Attributes

id string Unique identifier for the object.
object string, value is "privacy.redaction_job" String representing the object’s type. Objects of the same type share the same value.
created timestamp Time at which the object was created. Measured in seconds since the Unix epoch.
livemode boolean If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.
objects nullable object Includable The objects to redact in this job.
status enum The status of the job. Possible enum values canceled The job is canceled. No objects are redacted. canceling The job is canceling and no objects will be redacted. created This job is newly created and will begin validating shortly. failed The job failed to validate. View the job’s validation errors for more information. ready The job is ready to run or cancel. redacting The job is running. It is redacting the job’s specified objects. succeeded The job is complete. The job’s objects are redacted. validating The job is checking if the objects are eligible for redaction.
validation _ behavior nullable enum Validation behavior determines how a job validates objects for redaction eligibility. 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.
validation _ errors nullable object The first 10 validation errors for the current validation attempt. Use the validation errors list endpoint to paginate through the full list.

The Redaction Job object

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

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"}