Developers/Reference

Error codes

Every error answers application/problem+json (RFC 9457) with a stable code, a human title and detail, optional field errors and the requestId to quote to support. The type is the address of the code's page on this site.

JSON
{
  "type": "https://docs.postbuddy.nl/errors/validation_failed",
  "title": "Validation failed",
  "status": 422,
  "code": "validation_failed",
  "detail": "The request body is invalid",
  "errors": [
    {
      "field": "name",
      "code": "too_small",
      "message": "String must contain at least 1 character(s)"
    }
  ],
  "requestId": "req_01J…"
}

Codes

CodeStatusTitle
organisation_context_required400Organisation header required
api_key_invalid401API key invalid
api_key_revoked401API key revoked
authentication_required401Authentication required
credit_limit_reached402Credit limit reached
insufficient_balance402Insufficient balance
admin_permission_required403Console permission required
allowance_exceeded403Allowance exceeded
blocked_in_support_session403Blocked in support session
csrf_failed403Cross-site request refused
feature_not_entitled403Feature not entitled
insufficient_scope403Insufficient scope
integration_disabled403Integration disabled
invitation_email_mismatch403Invitation was sent to another email address
mfa_enrolment_required403Second factor enrolment required
organisation_suspended403Organisation suspended
permission_denied403Permission denied
postflow_limit_reached403Postflow limit reached
product_not_entitled403Product not entitled
step_up_required403A fresh second factor code is required
not_found404Not found
already_member409Already a member of this organisation
asset_in_use409Asset in use
folder_not_empty409Folder not empty
idempotency_in_progress409Request with this idempotency key in progress
invalid_item_transition409Invalid item transition
invalid_postbatch_transition409Invalid Postbatch transition
invitation_pending409An invitation for this email is already pending
item_locked_for_production409Item locked for production
last_owner409The last Owner cannot be removed or demoted
last_super_admin409The last Super admin cannot be disabled, removed or demoted
postflow_archived409Postflow archived
product_activation_blocked409Product activation blocked
specification_immutable409Specification version is immutable
still_referenced409Still referenced
template_archived409Template archived
template_in_use409Template in use
ticket_closed409Ticket closed
upload_incomplete409Upload not completed
invitation_expired410Invitation expired or withdrawn
draft_conflict412Draft was modified elsewhere
import_too_large413Import too large
upload_too_large413Upload too large
base_template_violation422Base template rules broken
destination_not_supported422Destination not supported
idempotency_key_reused422Idempotency key reused with a different body
image_url_not_allowed422Image URL not allowed
import_invalid_file422Import file invalid
item_render_failed422Item could not be rendered
mapping_incomplete422Mapping incomplete
upload_rejected422Upload rejected
validation_failed422Validation failed
variable_name_conflict422Variable names conflict
rate_limited429Rate limited
internal_error500Internal error
service_unavailable503Service unavailable
vies_unavailable503VAT validation service unavailable

Warning codes on items

Items that need attention carry one or more of these codes.

  • address_invalid
  • postal_code_invalid
  • house_number_missing
  • city_missing
  • country_not_supported
  • destination_not_supported
  • variable_missing
  • variable_type_invalid
  • variable_too_long
  • image_fetch_failed
  • image_resolution_low
  • text_overflow
  • expression_invalid
  • late_delivery_expected
  • waiting_for_funds
  • suppressed
  • carrier_codes_missing
  • excluded_from_run