Sign in
Redactions

Updates the details of a single redaction

put/v1/accounts/{accountSid}/redactions/{redactionSid}

Path parameters

accountSidstring required

accountSid

accountSid

redactionSidstring required

redactionSid

redactionSid

Request body

enabledboolean required

If the redaction is currently enabled or not.

descriptionstring nullable

A short description for the redaction.

patternstring nullable required

The pattern that will be applied to find the data to redact.

redactAt'client' | 'server' required

Where the data should be redacted.

typestring required

The type of redaction, this can be one of the predefined types or custom.

level'full' | 'mask' | 'partial' required

The level of redaction that is applied to the data that is being redacted.

applyTo'key' | 'value' nullable required

When using a custom type, where the pattern should apply. If key, the pattern will look for a JSON or XML key/property. If value, the pattern will look for any data in the payload that matches the pattern/regular and redact it.

Response

Successful

sidstring required

Sid of the redaction

accountSidstring required

accountSid

descriptionstring nullable

A short description for the redaction.

patternstring nullable required

The pattern that will be applied to find the data to redact.

typestring required

The type of redaction, this can be one of the predefined types or custom.

redactAt'client' | 'server' required

Where the data should be redacted.

level'full' | 'mask' | 'partial' required

The level of redaction that is applied to the data that is being redacted.

applyTo'key' | 'value' nullable required

When using a custom type, where the pattern should apply. If key, the pattern will look for a JSON or XML key/property. If value, the pattern will look for any data in the payload that matches the pattern/regular and redact it.

enabledboolean required

If the redaction is currently enabled or not.

createdAtstring required
updatedAtstring nullable
deletedAtstring nullable