Skip to content

Change the accessibility policy

PUT
/api/v1/workspaces/{workspace}/accessibility/policy
curl --request PUT \
--url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/accessibility/policy \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "minTextPx": 1, "onSerious": "warn" }'

Permission: workspace:manage

Block makes Send Readiness turn Blocked on serious issues and stops publishing automations and transactional templates that have them. Live automations and published templates keep sending.

workspace
required

Workspace slug

string
/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Media typeapplication/json
object
minTextPx
required
integer format: int64
>= 12 <= 16
onSerious
required
string
Allowed values: warn block

OK

Media typeapplication/json
object
canManage
required
boolean
helpers
required
Array<string>
minTextPx
required
integer format: int64
>= 12 <= 16
onSerious
required
string
Allowed values: warn block
updatedAt
string format: date-time
updatedBy
string

Example

{
"onSerious": "warn"
}

Error

Media typeapplication/problem+json
object
code

Stable error code, e.g. permission_denied

string
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object>
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

helpers

Members who hold the missing permission

Array<string>
instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
meta
object
key
additional properties
permission

The missing permission key

string
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example

{
"detail": "Property foo is required but is missing.",
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "about:blank"
}