Create an invitation

API v3 is in preview

Endpoints and response shapes can change before general availability. API v2 is unchanged.

POST https://app.honeybadger.io/v3/account/invitations

Required scope team:write

Invites a user to the account.

Example request

curl -X POST "https://app.honeybadger.io/v3/account/invitations" \
  -H "Authorization: Bearer $HONEYBADGER_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com"
}'

Request body

Field	Type	Description
email required	email
role	string	A member's role in the account. Allowed values: Owner, Admin, Member.
disable_email_notifications	boolean	Create the member with email notifications off.
team_ids	array | null	IDs of teams to add the invitee to.

Responses

1

201 Invitation created

Example payload

{
  "data": {
    "id": "Ai9nRx",
    "account_id": "Ab3kL9",
    "email": "newmember@example.com",
    "role": "Member",
    "created_at": "2026-01-01T00:00:00Z",
    "accepted_at": "2026-01-01T00:00:00Z",
    "created_by": {
      "id": "Uz4wKm",
      "name": "Jane Smith",
      "email": "jane@example.com"
    },
    "accepted_by": {
      "id": "Uz4wKm",
      "name": "Jane Smith",
      "email": "jane@example.com"
    }
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Response schema17

Field	Type	Description
data required	object	An invitation to join an account.
data.id required	string
data.account_id required	string	ID of the account.
data.email required	string	Email address of the invitee.
data.role	string | null	Role granted upon acceptance. Allowed values: Owner, Admin, Billing, Member, null.
data.created_at	date-time	When the invitation was created.
data.accepted_at	date-time | null	When the invitation was accepted.
data.created_by	object | null	User who created the invitation.
data.created_by.id	string	ID of the user.
data.created_by.name	string | null	User name.
data.created_by.email	string	User email.
data.accepted_by	object | null	User who accepted the invitation.
data.accepted_by.id	string	ID of the user.
data.accepted_by.name	string | null	User name.
data.accepted_by.email	string	User email.
meta	object
meta.request_id	string	Unique identifier for the request, for correlating with support.

Errors

3

401 Unauthorized

The credential is missing, invalid, expired or revoked (unauthorized), or was sent in a way v3 doesn’t accept (see the examples).

Example payload: unauthorized (Missing, malformed, expired or revoked credential)

{
  "error": {
    "code": "unauthorized",
    "message": "Access denied"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Example payload: unsupported_auth_scheme (Sent as HTTP basic, which v3 does not accept)

{
  "error": {
    "code": "unsupported_auth_scheme",
    "message": "Send the credential as `Authorization: Bearer <token>`; v3 does not accept HTTP basic"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Example payload: credential_in_query (Sent as the `auth_token` query parameter)

{
  "error": {
    "code": "credential_in_query",
    "message": "Credentials must be sent in the Authorization header"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Response schema6

Field	Type	Description
error required	object
error.code required	string	Machine-readable code. Branch on this, not the message. Allowed values: unauthorized, unsupported_auth_scheme, credential_in_query, access_denied, insufficient_scope, requires_user_token, project_restricted, account_inactive, account_parked, feature_unavailable, not_found, validation_error, delete_failed, limit_reached, rate_limit_exceeded, concurrent_request, streams_provisioning, ingestion_key_not_accepted, maintenance_mode, invalid_parameter, forbidden_attributes, service_unavailable, ambiguous_account, fault_merged.
error.message required	string	Human-readable explanation.
error.details	array<object> | object	A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta	object
meta.request_id	string	Unique identifier for the request, for correlating with support.

403 Forbidden

The credential isn’t allowed to do this. error.code says why. An account or project the credential doesn’t cover is 404 not_found, not 403.

Example payload: access_denied (The credential isn't allowed to do this to this record)

{
  "error": {
    "code": "access_denied",
    "message": "Access denied"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Example payload: insufficient_scope (The credential lacks the permission this endpoint requires)

{
  "error": {
    "code": "insufficient_scope",
    "message": "Insufficient scope",
    "details": {
      "required_scope": "faults:write",
      "token_scopes": [
        "faults:read",
        "insights:read"
      ]
    }
  },
  "meta": {
    "request_id": "abc123"
  }
}

Example payload: requires_user_token (The endpoint records who acted, and an account token has nobody)

{
  "error": {
    "code": "requires_user_token",
    "message": "This endpoint records the person who acted, so it requires a user credential rather than an account token"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Example payload: project_restricted (A project-restricted credential cannot create a project)

{
  "error": {
    "code": "project_restricted",
    "message": "Project-restricted tokens cannot create projects"
  },
  "meta": {
    "request_id": "abc123"
  }
}

Response schema6

Field	Type	Description
error required	object
error.code required	string	Machine-readable code. Branch on this, not the message. Allowed values: unauthorized, unsupported_auth_scheme, credential_in_query, access_denied, insufficient_scope, requires_user_token, project_restricted, account_inactive, account_parked, feature_unavailable, not_found, validation_error, delete_failed, limit_reached, rate_limit_exceeded, concurrent_request, streams_provisioning, ingestion_key_not_accepted, maintenance_mode, invalid_parameter, forbidden_attributes, service_unavailable, ambiguous_account, fault_merged.
error.message required	string	Human-readable explanation.
error.details	array<object> | object	A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta	object
meta.request_id	string	Unique identifier for the request, for correlating with support.

422 Unprocessable Content

Validation error

Example payload

{
  "error": {
    "code": "validation_error",
    "message": "Name can't be blank",
    "details": [
      {
        "field": "name",
        "message": "can't be blank"
      }
    ]
  },
  "meta": {
    "request_id": "abc123"
  }
}

Response schema6

Field	Type	Description
error required	object
error.code required	string	Machine-readable code. Branch on this, not the message. Allowed values: unauthorized, unsupported_auth_scheme, credential_in_query, access_denied, insufficient_scope, requires_user_token, project_restricted, account_inactive, account_parked, feature_unavailable, not_found, validation_error, delete_failed, limit_reached, rate_limit_exceeded, concurrent_request, streams_provisioning, ingestion_key_not_accepted, maintenance_mode, invalid_parameter, forbidden_attributes, service_unavailable, ambiguous_account, fault_merged.
error.message required	string	Human-readable explanation.
error.details	array<object> | object	A list of {field, message} on validation_error and invalid_parameter, and on feature_unavailable or limit_reached when one field caused the refusal; {required_scope, token_scopes} on insufficient_scope; {merged_into, location} on fault_merged. Absent when there's nothing to add.
meta	object
meta.request_id	string	Unique identifier for the request, for correlating with support.