Docs menu

Forbidden (403)

The key is valid but may not do this.

type: https://officehero.io/errors/forbidden

When you get it

  • The key lacks the scope the endpoint needs; missing_scope names it.
  • A webhook endpoint subscribes to an event family whose read scope the key lacks (missing_scope, missing_scopes).
  • Replaying a delivery with personal data to an endpoint not enabled for it (errors.integrations.deliveries.pii_not_granted).

What to do

Create a key that includes the scope in missing_scope. Existing keys cannot be widened.

detail_key values

detail_keyStatusEnglish detail
errors.integrations.deliveries.pii_not_granted403This delivery carries personal data and the endpoint is not approved to receive it. OfficeHero must enable the endpoint for personal data first — contact support.
errors.integrations.missing_scope403The API key does not have the scope required for this endpoint.

All error types and keys →