Documentation

Problem types

Every API error is an application/problem+json document. Its type member is one of the 190 addresses below; open it to see what the error means and what to do next.

A code a Player shows on its own screen is explained in Player status codes.

Problem types

project_required

400 · Select a project

action: none
free_organization_limit

409 · Free organization limit reached

action: none
organization_plan_required

409 · The organization needs a plan before it admits screens

action: none
project_name_conflict

409 · Project name already used in the organization

action: none
project_delete_blocked

409 · Project cannot be deleted in its current state

action: none
owner_required

409 · A responsible person is required

action: none
owner_cannot_leave

409 · The project owner cannot leave

action: none
internal_error

500 · Internal server error

action: retry_backoff
invalid_request

400 · Request is invalid

action: hold_lkg
unauthorized

401 · Authentication is required

action: remint
credential_retired

401 · Credential was retired

action: none
client_update_required

410 · Update the screenRIG plugin or CLI

action: none
forbidden

403 · Request is not allowed

action: hold_lkg
insufficient_access

403 · This access level cannot do this

action: none
outside_upload_scope

403 · Outside this uploader's playlists and folders

action: none
outside_screen_scope

403 · Outside this member's screens

action: none
protected_target

409 · A protected screen is not changed this way

action: none
second_approver_required

403 · A second approver must decide this review

action: none
reserved_item

403 · This campaign is reserved

action: none
approver_required

403 · Only an approver can do this

action: none
review_not_pending

409 · The review is no longer pending

action: none
review_stale

409 · The subject changed after this proposal

action: none
review_blocked

409 · Another review must be decided first

action: none
playlist_not_approved

409 · The playlist has no approved version

action: none
media_pending_review

409 · The media item is waiting for a person's review

action: none
media_sync_source_refused

409 · The media sync source refused the request

action: none
media_sync_source_unavailable

500 · The media sync source could not be reached

action: retry_backoff
canva_not_configured

409 · Canva is not configured

action: none
canva_reconnect_required

409 · The Canva account needs to be connected

action: none
dropbox_not_configured

409 · Dropbox is not configured

action: none
dropbox_reconnect_required

409 · The Dropbox account needs to be connected

action: none
google_drive_not_configured

409 · Google Drive is not configured

action: none
media_sync_sharer_not_member

403 · The folder was not shared by a project member

action: none
not_found

404 · Resource was not found

action: hold_lkg
method_not_allowed

405 · Method is not allowed

action: hold_lkg
idempotency_mismatch

409 · Idempotency key does not match the original request

action: retry_backoff
credential_issuance_expired

410 · Credential issuance expired

action: none
user_email_conflict

409 · Email address belongs to another person

action: none
provisioning_invalid

404 · Browser provisioning invalid

action: none
provisioning_expired

410 · Browser provisioning expired

action: none
provisioning_consumed

409 · Browser provisioning consumed

action: none
provisioning_exchange_mismatch

409 · Browser provisioning exchange mismatch

action: none
browser_already_paired

409 · Browser already paired

action: none
handoff_code_invalid

404 · Browser handoff code invalid

action: none
handoff_code_expired

410 · Browser handoff code expired

action: none
handoff_session_rate_limited

429 · Browser handoff session rate limited

action: none
handoff_session_conflict

409 · Browser handoff session conflict

action: none
browser_link_not_claimed

409 · Browser link not claimed

action: none
browser_link_project_mismatch

403 · Browser link project mismatch

action: none
origin_not_allowed

403 · Origin is not allowed

action: hold_lkg
resource_conflict

409 · Resource state conflicts with the request

action: retry_backoff
card_not_found

404 · Card not found

action: none
card_invalid

400 · Card placement is invalid

action: none
card_layout_invalid

400 · Card layout is invalid

action: none
card_layout_conflict

400 · Cards on the page claim the same place

action: none
card_data_invalid

409 · Card data document does not fit a card that reads it

action: none
source_limit_reached

409 · Organization has the maximum data sources

action: none
source_target_unsupported

422 · The data source cannot fill this card

action: none
source_target_taken

409 · Another data source already writes this card

action: none
source_busy

409 · A sync of the data source is running

action: none
source_has_no_rooms

409 · This kind of data source offers no rooms

action: none
source_secret_required

400 · A data source secret is missing or no longer fits

action: none
source_test_failed

422 · The data source preview failed

action: none
connection_app_not_configured

409 · screenRIG's app is not configured for this provider

action: none
connection_limit_reached

409 · Organization has the maximum connections

action: none
card_media_invalid

400 · Card media reference does not name a ready image

action: none
revision_conflict

412 · Resource revision does not match

action: hold_lkg
invalid_range

416 · Requested byte range is not satisfiable

action: retry_backoff
quota_exceeded

413 · Project content quota is exceeded

action: hold_lkg
payment_required

402 · Payment is required

action: hold_lkg
reseller_generation_limit

402 · Reseller image generation limit reached

action: none
feature_not_in_plan

402 · This feature is not in the project's plan

action: none
rate_limited

429 · Request rate is too high

action: retry_backoff
revocation_unavailable

500 · Credential revocation state is unavailable

action: none
dependency_unavailable

500 · Required dependency is unavailable

action: retry_backoff
dependency_timeout

500 · Required dependency did not answer in time

action: retry_backoff
schema_incompatible

500 · Database schema is incompatible

action: retry_backoff
not_ready

500 · Service is not ready

action: retry_backoff
server_draining

421 · Service is draining

action: retry_backoff
manifest_degraded

500 · Runtime manifest projection is degraded

action: hold_lkg
screenshot_unavailable

409 · Screenshot is not available

action: hold_lkg
identity_invalid

400 · Player public key is invalid

action: hold_lkg
identity_conflict

409 · Player public key does not match the enrollment

action: none
enrollment_bound

409 · Player public key is already bound to a project

action: none
proof_invalid

401 · Player identity proof is invalid

action: retry_backoff
screen_archived

409 · Screen is archived

action: clear_lkg
screen_archive_required

409 · Archive the screen instead of deleting or unbinding it

action: hold_lkg
passkey_invalid

401 · Passkey ceremony is invalid

action: none
passkey_unknown

401 · This passkey is no longer registered

action: none
passkeys_disabled

403 · Passkeys are disabled on this server

action: none
application_in_use

409 · A live manifest still references an application release

action: none
agent_connection_invalid

404 · Agent connection is invalid

action: none
agent_connection_code_mismatch

400 · The code does not match this sign-in

action: none
agent_connection_expired

410 · Agent connection is expired

action: none
agent_connection_conflict

409 · Agent connection is already resolved

action: none
agent_connection_not_approved

409 · Agent connection is not approved

action: none
agent_limit_exceeded

409 · Agent limit is exceeded

action: none
agent_lockout_risk

409 · Disconnecting the last active agent risks lockout

action: none
recovery_ambiguous

409 · Device identifier is attached to more than one screen

action: none
recovery_expired

410 · Screen recovery offer has expired

action: none
recovery_not_offered

404 · No screen recovery is pending

action: none
invitation_limit_reached

409 · Organization has the maximum outstanding invitations

action: none
organization_admin_limit

409 · Organization admin limit reached

action: none
library_no_screens

409 · A project with screens can't be the Library

action: none
guest_not_allowed

403 · The organization does not admit this person as a guest

action: none
managed_member

409 · An identity provider manages this person

action: none
organization_admin_member

409 · This member is an organization admin

action: none
member_owns_projects

409 · This member owns projects in the organization

action: none
managed_elsewhere

409 · Another organization manages this person

action: none
version_required

409 · Playlist requires a newer API version

action: none
price_change_pending

409 · Campaign is paused until new rates are accepted

action: none
quote_stale

409 · Advertising quote is stale or expired

action: none
insufficient_credits

402 · Eligible credits are insufficient

action: none
self_deal

409 · A project cannot buy advertising in its own network

action: none
goal_overbooked

409 · The goal is larger than the available plays

action: none
invitation_invalid

404 · Invitation is invalid

action: none
invitation_expired

410 · Invitation is expired

action: none
invitation_consumed

409 · Invitation is already accepted

action: none
invitation_email_mismatch

403 · Invitation belongs to a different email address

action: none
reauthentication_required

401 · Fresh sign-in proof is required

action: none
member_limit_reached

409 · Project has the maximum members

action: none
project_limit_reached

409 · Organization has the maximum projects

action: none
billed_by_reseller

409 · The organization is billed through its reseller

action: none
reseller_conflict

409 · The organization cannot take that reseller role

action: none
last_credential

409 · Last sign-in method cannot be removed

action: none
sso_required

403 · This address signs in through its identity provider

action: none
no_project

409 · No current project is selected

action: none
feature_unavailable

404 · This feature is not available on this server

action: hold_lkg
user_binding_stale

409 · Claiming user email binding is stale

action: none
session_expired

401 · Runtime session is expired or no longer current

action: remint
credential_revoked

401 · Device credential no longer binds this device to a screen

action: repair
screen_link_invalid

401 · Screen link is not valid

action: clear_lkg
screen_link_not_found

404 · Screen has no link

action: none
proof_clock_skew

401 · Player identity proof is outside the accepted time window

action: retry_backoff
key_retired

401 · Player key was replaced and its grace window has closed

action: repair
assignment_not_found

404 · Screen has no playlist assignment

action: clear_lkg
upgrade_required

403 · Player version is below the supported minimum

action: upgrade_required
reboot_unsupported

409 · Screen cannot reboot remotely

action: none
command_unsupported

409 · Screen cannot do this remotely

action: none
play_page_unsupported

409 · Screen cannot play a page on request

action: none
identify_unsupported

409 · Screen cannot identify itself

action: none
volume_unsupported

409 · Screen cannot set its volume

action: none
display_output_unsupported

409 · Screen cannot set its output mode

action: none
display_cec_unsupported

409 · Screen cannot take its display's input over CEC

action: none
page_not_on_screen

409 · Page is not in the playlist the screen is playing

action: none
live_unsupported

409 · Screen cannot show live view

action: none
live_unavailable

409 · Live view is not available for this screen

action: none
live_not_ready

409 · The screen is not publishing yet

action: none
live_session_ended

410 · The live session has ended

action: hold_lkg
wall_unsupported

409 · Screen cannot lay out a video wall

action: none
playlist_format_mismatch

409 · Playlist format does not match the screen's video wall

action: none
primitive_locked

403 · A locked element can be changed only by an approver

action: none
playlist_is_template

409 · The playlist is a template

action: none
webhook_limit_reached

409 · Organization has the maximum webhooks

action: none
alert_not_open

409 · Alert is not open

action: none
alert_mute_limit_reached

409 · Organization has the maximum mutes

action: none
notification_limit_reached

409 · Organization has the maximum notifications

action: none
notification_covers_other_projects

409 · Notification covers other projects

action: none
report_subscription_limit_reached

409 · Organization has the maximum report subscriptions

action: none
fleet_link_limit_reached

409 · Organization has the maximum fleet links

action: none
webhook_url_rejected

400 · Webhook URL must be HTTPS on a public Internet host

action: none
notification_destination_rejected

400 · Notification destination is not valid for its channel

action: none
document_not_shared

400 · Document asks viewers to sign in

action: none
note_contains_credential

422 · Note text contains a credential

action: none
note_rejected

422 · Note text was rejected

action: none
note_not_open

409 · Note is not open

action: none
note_limit_reached

409 · Organization has the maximum open notes

action: none
trigger_limit_reached

409 · Organization has the maximum triggers

action: none
bi_upstream_refused

409 · The BI system refused the connection

action: none
bi_upstream_unavailable

500 · The BI system could not be reached

action: none
bi_web_unavailable

409 · This server has no page renderer

action: none
schedule_import_invalid

422 · The import has rows with errors

action: none
schedule_import_stale

409 · The project changed since the preview

action: none
campaign_limit_reached

409 · Organization has the maximum campaigns

action: none
kv_webhook_limit_reached

409 · Application has the maximum key/value webhooks

action: none
support_conversation_closed

409 · Support conversation is closed

action: none
submission_too_short

422 · Submission is too short to act on

action: none
submission_unclear

422 · Submission does not describe a problem or request

action: none
submission_rejected

422 · Submission was not accepted

action: none
submission_screening_unavailable

500 · Submission cannot be screened right now

action: none
demo_slot_unavailable

409 · Demo time is no longer available

action: none
agentid_claim_invalid

400 · AgentID claim is invalid or expired

action: none
agentid_already_enrolled

409 · AgentID is already enrolled

action: none
account_exists

409 · This email already has a screenRIG account

action: none
email_verification_required

403 · Verify your email to continue

action: none
unverified_account_replacement

409 · This reset creates a new, empty account

action: none
app_store_transaction_invalid

422 · App Store purchase could not be verified

action: none
app_store_account_mismatch

409 · Purchase belongs to another organization

action: none
education_not_eligible

403 · Organization is not eligible for the Education plan

action: none
app_store_plan_conflict

409 · Organization already holds a plan

action: none