Organizations

Invite a member by email (owner/admin)

Changed on

Invites an email address to the organization with any role but owner, up to your own access (custom roles need permissions enabled). Expires in seven days. Records a pending invite and emails the address. The response status is always "invited"; the user becomes a member only after they accept (POST /v1/me/invites/{orgId}/accept). Re-inviting the same email refreshes the invite's role and expiry. 409 if the email already belongs to a member.

Checked against the member.invite permission for the resource it acts on. See Permissions for the roles and API key permissions that include it.

post/v1/orgs/{orgId}/members/add

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/orgs/{orgId}/members/add
  • Auth
    HTTP bearer

Path parameters

orgIdstring required

Request body

emailstring required
role'admin' | 'member' | 'viewer' | 'billing' | 'inference'

A built-in role. billing and inference need permissions enabled.

roleIdstring

A custom role's id (role_...), for an organization with permissions enabled.

Response

Added

avatarUrlstring
emailstring
fullNamestring
invitedAtstring
joinedAtstring
rolestring required
roleNamestring

The role's display name (permissions enabled only).

status'active' | 'invited'

Set only on the addOrgMember response, where it is "invited": the invite is recorded and emailed, and the user becomes a member only after accepting it. Listed and updated members omit it, and "active" is not returned.

userIdstring required

Changes

  • 7fe59d94a9f5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 12b2fcbcc298Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      added the new billing enum value to the request property

    • info

      added the new inference enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status