Sign in
organizations

Invite Active Organization Member

Changed on

Invite an address to the caller's active organization by email.

Organization owners and admins only. Unlike POST /me/members, the membership lands invited rather than active: it becomes active once the recipient accepts (POST /api/v1/invitations/accept). The response always carries the accept link, whether or not it was actually emailed (mail_sent), so an operator can share it themselves when mail is not configured or the send fails.

post/api/v1/organizations/me/member-invitations

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Request body

emailstring email required
role'owner' | 'admin' | 'member' | 'viewer'

Response

Successful Response

accept_linkstring nullable

The link to share with the invitee yourself, set only when mail_sent is false. A delivered link goes to the invitee's mailbox alone, so the inviter cannot open it as them.

created_atstring date-time required
emailstring required
expires_atstring date-time required
invitation_idstring uuid required
mail_sentboolean required

Whether the invitation email was actually dispatched. False when mail is not configured, or the send itself failed.

organization_member_idstring uuid required
rolestring required
status'invited'

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • 1637f1c09667Revision changes
    • breaking

      the response property became optional for the status

    • breaking

      response property accept_link list-of-types was widened by adding types null to media type application/json of response 201