Sign in
Organization

Create Invite For A User To Join The Organization By Email

Send an email invitation for a user to join the organization.

An invitation email will be sent to the specified address with a link to accept the invitation. Organization admins can invite users to any branch, while branch admins can only invite to their own branches.

post/api/v2/organization/invite

Headers

language'AR' | 'EN'

Request body

emailstring email required

Email address of the user to invite. May already be registered; rejected only if they are already a member of this organization.

role'organization_admin' | 'branch_admin' | 'branch_user' required
branchesstring[] required

List of branch IDs where the user will have access.

Response

Successful Response

idstring uuid
emailstring email
organization_idstring uuid
expire_atstring date-time
created_bystring uuid
role'organization_admin' | 'branch_admin' | 'branch_user'
branchesstring[]

Changes

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