Error codes

Every error response has error.type, error.code, a readable error.message, a doc_url linking here, and a request_id to quote to support.

CodeHTTPMeaning
authentication_required401No API key was sent, or the Authorization header was not a Bearer token.
invalid_api_key401The key is malformed or does not exist.
api_key_revoked401The key was revoked.
api_key_expired401The key was rotated and its grace period has ended.
ip_not_allowed401This key is restricted to specific IP addresses and the request came from another one.
api_requires_pro402The REST API is part of the Pro plan.
api_access_paused402The team is no longer on Pro, so API access is paused.
subscription_inactive402The subscription is past due or cancelled.
insufficient_scope403The key is valid but is a restricted key without the scope this endpoint needs.
plugin_key_unbound403A plugin key (pk_) is not bound to a tracked entity.
resource_not_found404No resource with that id is visible to this key.
unknown_endpoint404The path or method is not part of the API.
not_found404The path is not under /v1 on api.frontpagely.com.
wrong_host404The API was called on frontpagely.com instead of the API host.
missing_required_field400A required body field is missing.
parameter_missing400A required query parameter is missing (for example tracked_entity_id).
invalid_url400A webhook endpoint URL is not a valid public https URL.
invalid_event400An event type is not one Frontpagely sends.
invalid_events400The events field is not a non-empty array of strings.
invalid_status400The status filter or value is not one the endpoint accepts.
idempotency_key_too_long400The Idempotency-Key header is longer than 255 characters.
idempotency_key_mismatch422This Idempotency-Key was already used with a different request body.
etag_mismatch409The resource changed since you fetched it (your If-Match ETag is stale).
rate_limit_exceeded429Too many requests for this key in the current minute.
internal_error500Something failed on our side.

Questions about the API? Contact support, and include the request_id from any error.