A failed request has a status from 400 up and one body shape. Branch on code. The message is for a person and may be reworded.
Docs menu
JSON
{"error":{"type":"invalid_request","code":"too_many_pages","message":"This check has more pages than your account may send in one check.","param":"pages","request_id":"req_0Lr8L2F9yU1hFe3vC8xDmL"}}
type is the family. code is stable: it never changes meaning within v1, and new codes are only added.
param names the field at fault, when one is.
request_id is on every answer, in the Request-Id header too. Quote it when you write to us.
A message never repeats what you sent, so it is safe to log.
Codes
invalid_request
Code
Status
Meaning
body_not_json
400
The request body must be a JSON object.
body_too_large
413
The request body is larger than 256 KB.
unknown_parameter
400
The request has a parameter this endpoint does not accept.
parameter_missing
400
A required parameter is missing.
parameter_invalid
400
A parameter has a value this endpoint does not accept.
pages_empty
400
Give at least one page address.
too_many_pages
400
This check has more pages than your account may send in one check.
no_usable_page
400
None of the page addresses could be used. Each one is listed under rejected with its reason.
client_domain_invalid
400
The client domain is not a public web domain, such as example.com.
text_missing
400
A text check needs the text that was placed.
text_too_short
400
The text is too short to recognize on a page. Send at least 40 words.
text_too_long
400
The text is longer than 50,000 characters.
text_given_for_link_check
400
A link check takes no text. Leave text out, or use mode text.
mode_unknown
400
The mode must be auto, text or link_check.
schedule_unknown
400
The schedule must be daily, weekly or day7_day30.
brand_name_invalid
400
The brand name must be 1 to 80 characters.
logo_url_invalid
400
The logo address must be an https address.
brand_color_invalid
400
The brand color must be a hex color such as #1d47c5.
release_text_too_long
400
The release is longer than the package allows.
release_text_missing
400
This package needs the release text.
brief_missing
400
This package needs a brief for us to write from.
website_invalid
400
The website must be a public https address on your own domain.
screen_statement_missing
400
Confirm that the release has none of the refused content and that every link is yours.
idempotency_key_invalid
400
The Idempotency-Key header must be 1 to 255 printable characters.
cursor_invalid
400
The starting_after cursor does not name an object in this list.
limit_invalid
400
The limit must be a whole number from 1 to 100.
date_range_invalid
400
The dates must be YYYY-MM-DD, from before to, at most 92 days apart.
webhook_url_invalid
400
The webhook address must be a public https address without a user name or an IP address.
event_type_unknown
400
One of the event types is not a PressProve event.
scope_unknown
400
One of the scopes is not a PressProve scope.
key_name_invalid
400
The key name must be 1 to 60 characters.
authentication_error
Code
Status
Meaning
missing_api_key
401
Send your API key as Authorization: Bearer <key>.
invalid_api_key
401
The API key is not valid.
api_key_revoked
401
The API key has been revoked.
permission_error
Code
Status
Meaning
missing_scope
403
The API key does not have the scope this endpoint needs.
account_frozen
403
The account is frozen. Read requests still work; contact us to lift it.
account_not_onboarded
403
Finish the account details in the console first.
live_mode_closed
403
Live mode is not open yet. Test keys work now.
releases_closed
403
Publishing by API is not open.
test_only_endpoint
403
This endpoint works with test keys only.
country_blocked
403
We cannot serve this country.
identity_level_insufficient
403
Publishing needs the account to pass our business identity checks first.
business_details_required
403
Add your business details in the console before the first top-up.
pack_not_available
403
This top-up pack is not available to this account yet.
package_not_available
403
This package cannot be ordered through the API.
permission_denied
403
Your role in this workspace does not allow this.
limit_reached
403
The workspace has reached its limit of seats or client projects.
not_found
Code
Status
Meaning
not_found
404
No such object.
route_not_found
404
No such endpoint. The reference lists every one.
method_not_allowed
Code
Status
Meaning
method_not_allowed
405
This endpoint does not take that method. The Allow header lists the ones it takes.
conflict
Code
Status
Meaning
check_not_completed
409
The check has not completed.
check_not_cancelable
409
Only a queued check can be canceled.
monitor_not_active
409
The monitor is not active.
monitor_not_paused
409
The monitor is not paused.
monitor_ended
409
The monitor has ended.
pdf_not_ready
409
The PDF is not ready yet.
release_not_approvable
409
The release has no draft waiting for approval.
draft_changed
409
The draft has changed since you read it. Read the release again.
changes_already_used
409
The one round of changes has been used.
workspace_changed
409
You switched workspace in another tab. Reload the page and try again.
idempotency_error
Code
Status
Meaning
idempotency_key_reused
422
This Idempotency-Key was used with a different request.
insufficient_balance
Code
Status
Meaning
insufficient_balance
402
The balance is too low for this request.
rate_limited
Code
Status
Meaning
rate_limited
429
Too many requests. Wait for the time in Retry-After.
account_daily_limit
429
The account has used its pages for today (UTC).
pending_pages_limit
429
The account has too many pages waiting. Wait for a check to finish.
target_host_limit
429
That website has had as many checks as we make in a day. Try again tomorrow.
monitor_limit
429
The account has as many monitors or monitored pages as it may have.
key_limit
429
The account has as many keys as it may have in this mode.
webhook_endpoint_limit
429
The account has as many webhook endpoints as it may have.
reports_daily_limit
429
The account has made as many reports as it may today (UTC).
test_event_limit
429
This endpoint has had as many test events as it may in an hour. Try again later.
free_allowance_paused
429
Free checks are paused for today across PressProve. Top up to keep checking now, or try again tomorrow (UTC).
new_account_topup_limit
429
A new account may top up once a day and at most US$100 in its first 30 days.
daily_work_budget_reached
429
The account has used its checking time for the last 24 hours. Work already queued still finishes; try again after the time in Retry-After.
new_account_spend_limit
429
A new account may spend a limited number of credits in 24 hours. The limit lifts as the account ages.
api_error
Code
Status
Meaning
internal_error
500
Something went wrong on our side. Retry with the same Idempotency-Key.
unavailable
Code
Status
Meaning
engine_unavailable
503
Live checks are not available right now.
payments_unavailable
503
Payments are not available right now.
Pages we refuse in a check
When some pages of a check cannot be used, the check still runs for the rest. The refused ones are listed in rejected with one of these codes and are never charged. If none can be used the request fails with no_usable_page.
Code
Meaning
url_too_long
The address is longer than 2,048 characters.
unsupported_scheme:
The address is not a web address (for example mailto: or ftp:).
not_a_web_url
The address is not an http or https address.
not_a_url
The text could not be read as an address.
no_host
The address has no host name.
host_is_localhost
The address points at a local computer.
host_is_not_publicly_resolvable
The address is on a private network name.
host_is_ip_address
The address is an IP address, not a website name.
host_has_no_dot
The host name is not a public domain.
url_carries_credentials
The address carries a user name or password.
no_url_found_on_line
A line looked like an address but none could be read.
page_has_credentials
The address carries a user name or password. We never send credentials.
host_opted_out
The owner of this website has asked us not to check it.
host_personal_social
We do not check personal social-media pages or profiles.
A code that ends in a colon, such as unsupported_scheme:, is followed by a detail.
What to do
400, 402, 403, 404, 409, 422: fix the request or the account. Retrying the same request will not help.
429: wait for the time in Retry-After, then retry.
500 and 503: retry with the same Idempotency-Key, a little later each time.