Skip to content
Zautha

Invite several addresses to an organization

POST
/v1/backend/organizations/{organizationId}/invitations/bulk
curl --request POST \
  --url https://api.zautha.com/v1/backend/organizations/example/invitations/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "email_address": "example", "role": "example", "inviter_user_id": "example", "redirect_url": "example", "expires_in_days": 1, "public_metadata": {}, "private_metadata": {}, "notify": true } ]'

1 to 10 invitations in one request: one refused refuses them all.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
organizationId
required
string

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
string
>= 1 characters <= 255 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Array<object>
object
email_address
required
null | string
role
null | string
inviter_user_id
null | string
redirect_url
null | string
expires_in_days
null | integer format: int32
public_metadata
One of:
null
private_metadata
One of:
null
notify
null | boolean

Example generated

[
  {
    "email_address": "example",
    "role": "example",
    "inviter_user_id": "example",
    "redirect_url": "example",
    "expires_in_days": 1,
    "public_metadata": {},
    "private_metadata": {},
    "notify": true
  }
]

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
/^orginv_[0-9a-hjkmnp-tv-z]{26}$/
object
required
string
email_address
required
string
role
required
string
role_name
required
string
status
required
Allowed values: pending accepted revoked expired
public_organization_data
required
object
id
required
string
/^org_[0-9a-hjkmnp-tv-z]{26}$/
name
required
string
slug
required
null | string
inviter
required
One of:
null
public_metadata
required
object
private_metadata
required
object
redirect_url
required
null | string
accepted_user_id
required
One of:
null
url
required
null | string
expires_at
required
string format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
total_count
required
integer format: int32

Example 

{
  "data": [
    {
      "status": "pending"
    }
  ]
}

400

Section titled “400”

The request is malformed, or a field is not valid (validation_failed names each one in errors).

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

401

Section titled “401”

The secret key is missing or not valid.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

403

Section titled “403”

Forbidden.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

404

Section titled “404”

Not Found.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

409

Section titled “409”

Conflict.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

415

Section titled “415”

Unsupported Media Type.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

422

Section titled “422”

Unprocessable Entity.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

429

Section titled “429”

Too many requests with this secret key. Retry after the seconds in Retry-After.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}

Headers

Section titled “Headers”
Retry-After
integer format: int32

Seconds to wait before retrying.

503

Section titled “503”

The service is temporarily unavailable. Try again shortly.

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer format: int32
detail
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
trace_id
required
string
reverification
object
level
required
string
Allowed values: first_factor second_factor multi_factor
after_minutes
required
integer format: int32
>= 1 <= 1440
tasks
Array<string>
Allowed values: setup_mfa choose_organization
errors
Array<object>
object
field
required
string
code
required
string
Allowed values: bad_request unauthenticated forbidden resource_not_found method_not_allowed conflict unsupported_media_type payload_too_large rate_limited internal_error request_timeout error validation_failed plan_limit_reached too_many_requests rate_limiter_unavailable instance_not_ready idempotency_key_reused idempotency_key_in_use invalid_value invalid_length invalid_range invalid_origin invalid_redirect_uri required too_many domain_invalid format apex reserved domain_already_active domain_managed production_exists origin_invalid cookie_invalid redirect_url_invalid session_exists attempt_state_invalid attempt_expired form_param_invalid form_identifier_exists form_identifier_not_found form_username_exists form_username_invalid form_email_invalid form_password_length form_password_pwned form_password_context_word form_password_incorrect form_code_incorrect verification_failed verification_expired identifier_locked user_banned form_metadata_too_large reverification_required session_task_pending passkey_origin_unsupported form_passkey_invalid strategy_disabled oauth_access_denied oauth_token_exchange_error oauth_fetch_user_error oauth_identification_claimed external_account_exists oauth_account_already_connected captcha_required captcha_invalid captcha_unavailable consent_request_invalid id_token_hint_invalid oauth_client_public webhook_endpoint_limit webhook_url_invalid organizations_disabled organization_minimum_permissions_needed organization_not_found organization_slug_taken organization_slugs_disabled already_organization_member organization_membership_quota_exceeded organization_role_in_use organization_system_permission_not_modifiable organization_permission_limit_exceeded organization_invitation_exists organization_invitation_not_found organization_invitation_not_pending organization_invitation_email_mismatch organization_creation_disabled organization_creation_limit_exceeded organization_delete_disabled missing_organization_permission form_ticket_invalid personal_accounts_not_allowed workspace_personal workspace_not_empty workspace_locked workspace_last_owner already_workspace_member workspace_invitation_exists workspace_invitation_invalid workspace_invitation_email_mismatch billing_already_subscribed billing_no_customer billing_email_in_use billing_email_not_allowed billing_provider_error impersonation_forbidden impersonation_unavailable actor_token_not_pending
message
required
string

Example 

{
  "code": "bad_request",
  "reverification": {
    "level": "first_factor"
  },
  "tasks": [
    "setup_mfa"
  ],
  "errors": [
    {
      "code": "bad_request"
    }
  ]
}