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.
| Code | HTTP | Meaning |
|---|---|---|
authentication_required | 401 | No API key was sent, or the Authorization header was not a Bearer token. |
invalid_api_key | 401 | The key is malformed or does not exist. |
api_key_revoked | 401 | The key was revoked. |
api_key_expired | 401 | The key was rotated and its grace period has ended. |
ip_not_allowed | 401 | This key is restricted to specific IP addresses and the request came from another one. |
api_requires_pro | 402 | The REST API is part of the Pro plan. |
api_access_paused | 402 | The team is no longer on Pro, so API access is paused. |
subscription_inactive | 402 | The subscription is past due or cancelled. |
insufficient_scope | 403 | The key is valid but is a restricted key without the scope this endpoint needs. |
plugin_key_unbound | 403 | A plugin key (pk_) is not bound to a tracked entity. |
resource_not_found | 404 | No resource with that id is visible to this key. |
unknown_endpoint | 404 | The path or method is not part of the API. |
not_found | 404 | The path is not under /v1 on api.frontpagely.com. |
wrong_host | 404 | The API was called on frontpagely.com instead of the API host. |
missing_required_field | 400 | A required body field is missing. |
parameter_missing | 400 | A required query parameter is missing (for example tracked_entity_id). |
invalid_url | 400 | A webhook endpoint URL is not a valid public https URL. |
invalid_event | 400 | An event type is not one Frontpagely sends. |
invalid_events | 400 | The events field is not a non-empty array of strings. |
invalid_status | 400 | The status filter or value is not one the endpoint accepts. |
idempotency_key_too_long | 400 | The Idempotency-Key header is longer than 255 characters. |
idempotency_key_mismatch | 422 | This Idempotency-Key was already used with a different request body. |
etag_mismatch | 409 | The resource changed since you fetched it (your If-Match ETag is stale). |
rate_limit_exceeded | 429 | Too many requests for this key in the current minute. |
internal_error | 500 | Something failed on our side. |
Questions about the API? Contact support, and include the request_id from any error.