Qubitro API - Invite Member

Invite Member

`POST` /v2/organization/invite

Invite a new member to the organization by sending a POST request to the Qubitro API.

Supported roles include: admin, readonly, and readwrite.

invite.ts

import type { NextApiRequest, NextApiResponse } from 'next';
 
export default async function handler(
    req: NextApiRequest,
    res: NextApiResponse<any>
) {
    const requestBody = {
        email: "user.email@domain.com",
        role: "admin"
    };
 
    const result = await fetch('https://api.qubitro.com/v2/organization/invite', {
        headers: {
            'Content-Type': 'application/json',
            'Authorization': 'Bearer <API_KEY>'
        },
        method: "POST",
        body: JSON.stringify(requestBody)
    });
 
    const data = await result.json();
    res.status(200).json(data);
}

Request Body Parameters

Option	Type	Description
email	string	The email address of the user to invite.
role	string	The role to assign to the user. Supported values: admin, readonly, readwrite.

Response

On success, the API will return a JSON object with the following structure:

{
    "success": true,
    "action": "invite user",
    "status": 200
}

Response codes

Option	Type	Description
200	OK	The request was successful.
400	Bad Request	The request could not be understood or was missing required parameters.
401	Unauthorized	Authentication failed or was not provided.
403	Forbidden	Authentication succeeded, but the authenticated user does not have access to the requested resource.
404	Not Found	The requested resource could not be found.
500	Internal Server Error	An error occurred on the server.