People V2
Organization V2

Invite people to organization

Invites a new person to join an organization. Requires admin permissions.

post/v2/organization/{organizationName}/invite

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/organization/{organizationName}/invite
  • Auth: HTTP bearer

Path parameters

organizationNamestring required

Organization slug/name

Example:zephyr-cloud

Request body

namestring required

Name of the person being invited

emailstring email required

Email address to send invitation

role'viewer' | 'editor' | 'admin' | 'owner' required

Role to assign to the new member

usernamestring

Optional username

Example request

{
  "name": "Jane Smith",
  "email": "jane@example.com",
  "role": "editor",
  "username": "janesmith"
}

Response

Person invited successfully

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "John Doe",
    "email": "john@example.com",
    "role": "editor"
  }
}

Changes

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