Organizations

Invite User to Organization

Invite a user to join the organization.

Required Scope: write-invitations

post/v1/org/{org_id}/invitations

Request

  • Base URL: https://api.hubble.com
  • URL: https://api.hubble.com/v1/org/{org_id}/invitations
  • Auth: HTTP bearer

Path parameters

org_idstring uuid required

The ID for an organization

Your organization ID

Headers

Content-Typestring

An indication that the payload is JSON

Request body

invitee_emailstring email required

Email address of the user to invite

role'admin' | 'member' required

The role a user is assigned within an organization

Response

Invitation successfully created

invitee_emailstring email required

Email address of the invited user

inviter_emailstring email

Email address of the user who sent the invitation

created_atinteger required

An UTC second-precision timestamp formatted as an integer

expires_atinteger required

An UTC second-precision timestamp formatted as an integer

role'admin' | 'member' required

The role a user is assigned within an organization

Changes

No recorded changes to this operation across all 1 revision of this API.