Organizations

Invite Organization Member

Invite a user to the organization by email. If the user already has a ZeroPath account, they are added immediately. Otherwise, an invitation is sent. Calling this again for the same email re-invites them: any outstanding (pending or expired) invitation is revoked and a fresh one is sent. Requires MEMBER_INVITE permission.

post/api/v2/organizations/inviteMember

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring

Organization ID. If omitted, the organization is resolved from the authenticated user.

emailstring email required

Email address of the user to invite

role'ADMIN' | 'MEMBER'

Role to assign once the invitation is accepted. Defaults to MEMBER. Inviting as ADMIN requires MEMBER_EDIT (admin) permission.

Response

Successful response

okboolean

Changes

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