Create Organiztion Invitation

POST

/v1/organization_invitations

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: ********************

Body Params application/json

Example

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/organization_invitations' \
--header 'X-Jicoo-Api-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com",
    "role": "owner"
}'

Responses

🟢201Created

application/json

Body

Example

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

Modified at 2024-08-28 11:11:29

Update Organization User

List Organization Invitations