INinth
Members

Invite member

Changed on

Emails an invitation to join the organization. The invitation expires after 48 hours. Requires members.write, a user token, and an admin or owner role; only owners can invite owners. An address that is already a member or already invited answers 409.

post/v1/invitations

Request

  • Base URL
    https://api.inth.com
  • URL
    https://api.inth.com/v1/invitations
  • Auth
    HTTP bearer

Query parameters

organizationIdstring

Organization to act in. Defaults to the active organization of the credential; organization API keys always act in their own.

Request body

emailstring email required

Address to invite. Compared case-insensitively.

role'owner' | 'admin' | 'member' required

Role granted on acceptance. Only owners can invite owners.

Response

Created invitation.

successtrue required

Changes