API error codes | Affinity docs

Unsuccessful API responses use Problem Details. Read code to identify the error, status for the HTTP outcome, and detail for this occurrence. The type URL links to the corresponding page below.

Keep requestId for support. Read data.issues when the response includes field-level errors. Error detail text can change; branch on codes instead.

Code	Meaning
`bad_gateway`	The API or a dependency could not complete the request.
`bad_request`	The request contains invalid or incomplete values.
`clinical_requirements_unmet`	Required clinical information is incomplete.
`conflict`	The current resource state prevents this operation.
`diagnosis_review_conflict`	The clinical review status contradicts its list of medications or diagnoses.
`email_delivery_failed`	The invitation was saved but email delivery failed.
`forbidden`	Current access does not permit this operation.
`gone`	The resource is no longer available.
`idempotency_key_reused`	The key was already used for different request parameters.
`idempotency_key_too_long`	The Idempotency-Key header exceeds 255 characters.
`idempotency_request_in_progress`	Another request with this key is still running.
`idempotency_response_unavailable`	The original mutation result cannot currently be replayed.
`input_validation_failed`	The request contains invalid or incomplete values.
`internal_server_error`	The API or a dependency could not complete the request.
`invalid_cursor`	An identifier or pagination cursor is invalid.
`invalid_id`	An identifier or pagination cursor is invalid.
`invalid_license_expiration`	An optional license record could not be saved.
`invalid_request`	The request contains invalid or incomplete values.
`invalid_subscription`	The subscription is invalid for this operation.
`invitation_already_accepted`	The invitation is no longer pending.
`invitation_not_pending`	The invitation is no longer pending.
`license_exists`	An optional license record could not be saved.
`location_archived`	An active practice location is required.
`location_name_conflict`	The practice already has a location with this name.
`location_not_found`	The resource or route is unavailable in this request context.
`medication_review_conflict`	The clinical review status contradicts its list of medications or diagnoses.
`method_not_allowed`	The route does not support this HTTP method.
`not_found`	The resource or route is unavailable in this request context.
`order_authorization_changed`	Authorization changed while the operation was in progress.
`patient_address_conflict`	The requested address change conflicts with the patient's saved addresses.
`patient_address_default_conflict`	The requested address change conflicts with the patient's saved addresses.
`patient_address_default_required`	The requested address change conflicts with the patient's saved addresses.
`patient_address_limit`	The requested address change conflicts with the patient's saved addresses.
`patient_address_not_found`	The resource or route is unavailable in this request context.
`patient_has_orders`	The patient has orders that prevent deletion.
`patient_identifier_conflict`	A patient identifier is already assigned to another patient.
`patient_information_required`	Patient information or allergy review is incomplete.
`patient_location_required`	An active practice location is required.
`patient_not_found`	The resource or route is unavailable in this request context.
`permission_denied`	Current access does not permit this operation.
`platform_authorization_changed`	Authorization changed while the operation was in progress.
`platform_not_available`	The integration or practice connection is unavailable.
`platform_not_connected`	The integration or practice connection is unavailable.
`practice_authorization_changed`	Authorization changed while the operation was in progress.
`practice_not_accessible`	The integration or practice connection is unavailable.
`prescriber_connection_changed`	Authorization changed while the operation was in progress.
`prescriber_inviter_required`	The requested role or invitation cannot be assigned with current access.
`prescriber_profile_incomplete`	The selected clinician identity is not ready for this operation.
`prescribing_account_required`	The selected clinician identity is not ready for this operation.
`rate_limit_exceeded`	The request rate exceeds the current limit.
`referral_agreement_required`	Referral prerequisites or invitation timing prevent the request.
`referral_invite_cooldown`	Referral prerequisites or invitation timing prevent the request.
`reserved_metadata`	The request uses reserved metadata keys.
`reviewer_account_required`	The selected clinician identity is not ready for this operation.
`route_not_found`	The resource or route is unavailable in this request context.
`service_unavailable`	The API or a dependency could not complete the request.
`session_not_fresh`	This sensitive action requires recent authentication.
`signature_review_required`	The prescription needs review before signing.
`support_session_ended`	The support session is no longer active.
`team_account_connection_required`	The selected clinician identity is not ready for this operation.
`team_identity_conflict`	The supplied identity conflicts with an existing person.
`team_prescriber_unavailable`	The selected clinician identity is not ready for this operation.
`team_role_unavailable`	The requested role or invitation cannot be assigned with current access.
`too_many_requests`	The request rate exceeds the current limit.
`unauthorized`	Authentication is missing, invalid, or expired.
`unprocessable_entity`	The request contains invalid or incomplete values.
`unsupported_api_version`	The requested API version is unsupported.
`upstream_error`	The API or a dependency could not complete the request.
`webhook_organization_not_authorized`	The key cannot manage webhooks for the selected organization.