Cancel a redaction job Preview

Privacy
Redaction Job
Cancel a redaction job

You can cancel a redaction job when it’s in one of these statuses: ready, failed.

Canceling the redaction job will abandon its attempt to redact the configured objects. A canceled job cannot be used again.

Parameters

  • jobstringRequired

    RedactionJob object identifier

Returns

Returns the RedactionJob object if successful. Otherwise, returns an error.

POST /v1/privacy/redaction_jobs/:id/cancel
curl -X POST https://api.stripe.com/v1/privacy/redaction_jobs/prj_123/cancel \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
"id": "prj_123",
"object": "privacy.redaction_job",
"created": 1234567890,
"livemode": true,
"status": "canceling",
"validation_behavior": "error"
}