Create Invite

Create Invite

curl --request POST \
  --url https://api.example.com/api/v1/bko/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "phoneDdi": "55",
  "phoneNumber": "99999999999",
  "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "email": "novo@example.com",
  "phoneIso": "BR"
}
'

import requests

url = "https://api.example.com/api/v1/bko/invites"

payload = {
    "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "email": "novo@example.com",
    "phoneIso": "BR"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    roleId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    phoneDdi: '55',
    phoneNumber: '99999999999',
    organizationId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    email: 'novo@example.com',
    phoneIso: 'BR'
  })
};

fetch('https://api.example.com/api/v1/bko/invites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bko/invites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'roleId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    'phoneDdi' => '55',
    'phoneNumber' => '99999999999',
    'organizationId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    'email' => 'novo@example.com',
    'phoneIso' => 'BR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/bko/invites"

	payload := strings.NewReader("{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/bko/invites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/bko/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}"

response = http.request(request)
puts response.read_body

{
  "inviteId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "type": "MEMBER",
  "invitedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "token": "a1b2c3d4e5f6",
  "phoneIso": "BR",
  "phoneDdi": "55",
  "phoneNumber": "99999999999",
  "expiresAt": "2026-01-08T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "invitedBy": {
    "userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "name": "Maria Silva",
    "phoneIso": "BR",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "googleProviderId": "109876543210987654321",
    "email": "maria@example.com",
    "avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "organization": {
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "type": "COOPERATIVE",
    "name": "Cooperativa Metropolitana",
    "document": "45.723.174/0001-10",
    "documentType": "CNPJ",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "cooperative": {
      "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "company": {
      "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "industrySegment": "retail",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "address": {
      "organizationAddressId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "zipCode": "01310-100",
      "street": "Av. Paulista",
      "neighborhood": "Bela Vista",
      "number": "1000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "complement": "Sala 42",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "legalName": "Cooperativa Metropolitana de Transporte Ltda.",
    "tradeName": "Metropolitana",
    "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "phoneIso": "BR",
    "phoneDdi": "+55",
    "phoneNumber": "1133334444",
    "email": "contato@estrela.com",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "invitedUserId": null,
  "employeeId": null,
  "employee": {
    "employeeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "status": "ACTIVE",
    "name": "Maria Silva"
  },
  "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "transportOperatorId": null,
  "transportOperator": {
    "document": "12345678000190",
    "documentType": "CNPJ",
    "legalName": "Joao Silva Transportes Ltda",
    "transportOperatorId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "tradeName": "Silva Transportes"
  },
  "email": "novo@example.com",
  "createdBy": null,
  "updatedBy": null,
  "acceptedAt": null,
  "revokedAt": null,
  "rejectedAt": null,
  "invitedUser": {
    "userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "name": "Maria Silva",
    "phoneIso": "BR",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "googleProviderId": "109876543210987654321",
    "email": "maria@example.com",
    "avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "role": {
    "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "type": "ORGANIZATION",
    "name": "Administrador",
    "permissions": [
      "read:trip",
      "create:trip"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "description": "Acesso total à organização",
    "createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "deletedBy": null,
    "deletedAt": null
  }
}

{
  "errors": [
    {
      "message": "required",
      "path": "name"
    }
  ],
  "message": "Bad Request Error",
  "statusCode": 400
}

{
  "message": "Missing or invalid access token",
  "statusCode": 401
}

{
  "message": "Insufficient permissions",
  "statusCode": 403
}

{
  "message": "Internal Server Error",
  "statusCode": 500
}

POST

api

bko

invites

Create Invite

curl --request POST \
  --url https://api.example.com/api/v1/bko/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "phoneDdi": "55",
  "phoneNumber": "99999999999",
  "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "email": "novo@example.com",
  "phoneIso": "BR"
}
'

import requests

url = "https://api.example.com/api/v1/bko/invites"

payload = {
    "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "email": "novo@example.com",
    "phoneIso": "BR"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    roleId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    phoneDdi: '55',
    phoneNumber: '99999999999',
    organizationId: '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    email: 'novo@example.com',
    phoneIso: 'BR'
  })
};

fetch('https://api.example.com/api/v1/bko/invites', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/bko/invites",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'roleId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    'phoneDdi' => '55',
    'phoneNumber' => '99999999999',
    'organizationId' => '0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a',
    'email' => 'novo@example.com',
    'phoneIso' => 'BR'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/bko/invites"

	payload := strings.NewReader("{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/bko/invites")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/bko/invites")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"roleId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"phoneDdi\": \"55\",\n  \"phoneNumber\": \"99999999999\",\n  \"organizationId\": \"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a\",\n  \"email\": \"novo@example.com\",\n  \"phoneIso\": \"BR\"\n}"

response = http.request(request)
puts response.read_body

{
  "inviteId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "type": "MEMBER",
  "invitedByUserId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "token": "a1b2c3d4e5f6",
  "phoneIso": "BR",
  "phoneDdi": "55",
  "phoneNumber": "99999999999",
  "expiresAt": "2026-01-08T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "invitedBy": {
    "userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "name": "Maria Silva",
    "phoneIso": "BR",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "googleProviderId": "109876543210987654321",
    "email": "maria@example.com",
    "avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "organization": {
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "type": "COOPERATIVE",
    "name": "Cooperativa Metropolitana",
    "document": "45.723.174/0001-10",
    "documentType": "CNPJ",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "cooperative": {
      "cooperativeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "company": {
      "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "industrySegment": "retail",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "address": {
      "organizationAddressId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
      "country": "BR",
      "state": "SP",
      "city": "São Paulo",
      "zipCode": "01310-100",
      "street": "Av. Paulista",
      "neighborhood": "Bela Vista",
      "number": "1000",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "complement": "Sala 42",
      "createdBy": null,
      "updatedBy": null,
      "deletedBy": null,
      "deletedAt": null
    },
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "legalName": "Cooperativa Metropolitana de Transporte Ltda.",
    "tradeName": "Metropolitana",
    "logo": "organizations/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/logo/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "phoneIso": "BR",
    "phoneDdi": "+55",
    "phoneNumber": "1133334444",
    "email": "contato@estrela.com",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "invitedUserId": null,
  "employeeId": null,
  "employee": {
    "employeeId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "companyId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "status": "ACTIVE",
    "name": "Maria Silva"
  },
  "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
  "transportOperatorId": null,
  "transportOperator": {
    "document": "12345678000190",
    "documentType": "CNPJ",
    "legalName": "Joao Silva Transportes Ltda",
    "transportOperatorId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "tradeName": "Silva Transportes"
  },
  "email": "novo@example.com",
  "createdBy": null,
  "updatedBy": null,
  "acceptedAt": null,
  "revokedAt": null,
  "rejectedAt": null,
  "invitedUser": {
    "userId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "name": "Maria Silva",
    "phoneIso": "BR",
    "phoneDdi": "55",
    "phoneNumber": "99999999999",
    "phoneVerified": false,
    "emailVerified": false,
    "status": "ACTIVE",
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "googleProviderId": "109876543210987654321",
    "email": "maria@example.com",
    "avatar": "users/0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a/avatar/0195e7b2-4a3c-7d3e-9f4a-2c6b8d0e1f3b.png",
    "createdBy": null,
    "updatedBy": null,
    "deletedBy": null,
    "deletedAt": null
  },
  "role": {
    "roleId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "organizationId": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "type": "ORGANIZATION",
    "name": "Administrador",
    "permissions": [
      "read:trip",
      "create:trip"
    ],
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z",
    "description": "Acesso total à organização",
    "createdBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "updatedBy": "0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a",
    "deletedBy": null,
    "deletedAt": null
  }
}

{
  "errors": [
    {
      "message": "required",
      "path": "name"
    }
  ],
  "message": "Bad Request Error",
  "statusCode": 400
}

{
  "message": "Missing or invalid access token",
  "statusCode": 401
}

{
  "message": "Insufficient permissions",
  "statusCode": 403
}

{
  "message": "Internal Server Error",
  "statusCode": 500
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Body

application/json

Create invite payload

roleId

string<uuid>

required

Role identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

phoneDdi

string

required

International dialing code

Example:

"55"

phoneNumber

string

required

Phone number without country code

Example:

"99999999999"

organizationId

string<uuid> | null

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

string<email> | null

Invitee email

Example:

"novo@example.com"

phoneIso

string

Phone ISO country code

Example:

"BR"

Response

Created

Invite

inviteId

string<uuid>

required

Invite identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

type

enum<string>

required

Invite type

Available options:

MEMBER,

EMPLOYEE,

DRIVER

Example:

"MEMBER"

invitedByUserId

string<uuid>

required

Issuer user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

organizationId

string<uuid> | null

required

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

token

string

required

Invite token

Example:

"a1b2c3d4e5f6"

phoneIso

any

required

Phone ISO country code

Example:

"BR"

phoneDdi

any

required

International dialing code

Example:

"55"

phoneNumber

any

required

Phone number without country code

Example:

"99999999999"

expiresAt

string<date-time>

required

Expires at

Example:

"2026-01-08T00:00:00.000Z"

createdAt

string<date-time>

required

Created at

Example:

"2026-01-01T00:00:00.000Z"

invitedBy

object

required

User

Show child attributes

organization

object | null

required

Organization

Show child attributes

invitedUserId

string<uuid> | null

Invited user identifier

Example:

null

employeeId

string<uuid> | null

Employee identifier

Example:

null

employee

object | null

Invited employee

Show child attributes

roleId

string<uuid> | null

Role identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

transportOperatorId

string<uuid> | null

Transport operator identifier

Example:

null

transportOperator

object | null

Transport operator

Show child attributes

any | null

Invitee email

Example:

"novo@example.com"

createdBy

string<uuid> | null

Created by

Example:

null

updatedBy

string<uuid> | null

Updated by

Example:

null

acceptedAt

string<date-time> | null

Accepted at

Example:

null

revokedAt

string<date-time> | null

Revoked at

Example:

null

rejectedAt

string<date-time> | null

Rejected at

Example:

null

invitedUser

object | null

User

Show child attributes

role

object | null

Role

Show child attributes

Customer

Driver

OPS

BKO

Authorizations

Query Parameters

Body

Response