Create Organiztion Invitation - Jicoo Developer Potal

The Create Organization Invitation API allows administrators to send an invitation to a new user to join the organization. By providing the necessary details, such as the recipient’s email and role, this API generates and sends an invitation, enabling the recipient to join the organization with the specified permissions.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: 2f68dbbf-519d-4f01-9636-e2421b68f379

Body Params application/json

string <email>

required

Email of the invitee

role

enum<string>

optional

Role assigned to the invitee

Allowed values:

owneradminmemberrestricted

Example

{
  "email": "user@example.com",
  "role": "owner"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

data

object (OrganizationInvitation)

required

integer

required

Unique ID of the invitation

> 0

string <email>

required

Email of the invitee

role

enum<string>

required

Role assigned to the invitee

Allowed values:

owneradminmemberrestricted

createdAt

string <date-time>

required

Creation time of the invitation

updatedAt

string <date-time>

required

Last update time of the invitation

Example

{
  "data": {
    "id": 1,
    "email": "user@example.com",
    "role": "owner",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}