REST API
Organization
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

OptionTypeDescription
emailstringThe email address of the user to invite.
rolestringThe 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
OptionTypeDescription
200OKThe request was successful.
400Bad RequestThe request could not be understood or was missing required parameters.
401UnauthorizedAuthentication failed or was not provided.
403ForbiddenAuthentication succeeded, but the authenticated user does not have access to the requested resource.
404Not FoundThe requested resource could not be found.
500Internal Server ErrorAn error occurred on the server.

logo

Start building today

Collect, process, and activate device data. Scale from one device to thousands.

Qubitro Logo

Product

Decision Aids

Resources

Company

© 2024 Qubitro, Inc. All rights reserved