Invite user to organization

Organization Users Invite user to organization

POST

/control-plane/api/v1/v1/organization/{organization_id}/user/invite

Authentication

API Key (BearerAuth)

Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID

Request Body

Invite user input

Required

documentation_idsstring[]

emailstringrequired

rolestring

Example:

{
  "documentation_ids": [
    "string"
  ],
  "email": "string",
  "role": "string"
}

Responses

201

Created

Response Fields:

created_at (string)
documentation_ids (string[])
email (string)
id (string)
invited_at (string)
invited_by (string)
joined_at (string)
name (string)
organization_id (string)
profile_picture_url (string)
role (string)
status (string)
updated_at (string)
user_id (string)

Example:

{
  "created_at": "string",
  "documentation_ids": [
    "string"
  ],
  "email": "string",
  "id": "string",
  "invited_at": "string",
  "invited_by": "string",
  "joined_at": "string",
  "name": "string",
  "organization_id": "string",
  "profile_picture_url": "string",
  "role": "admin",
  "status": "pending",
  "updated_at": "string",
  "user_id": "string"
}

400

Bad Request

Example:

{
  "key": "value"
}

401

Unauthorized

Example:

{
  "key": "value"
}

500

Internal Server Error

Example:

{
  "key": "value"
}