← HomeFleetPay / API

Issue collective invite code for carriers

Parameters, data structure and responses from the versioned contract.

POST/convites/transportadoras/coletivo
emitirConviteColetivoTransportadorasSandbox Base: https://api.fleetpay.site/v1

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Generates a bearer invite code valid for 90 days for collective onboarding of partner carriers (does not send messages automatically). Requires cadastros scope.

Authentication

Required Scope
cadastros — Registrations
Module
Base Registrations & Lookups
Target Profiles
Shipper · Transport Manager · Dedicated Fleet Contractor · Fleet Carrier
Schemes
OAuth2 client_credentials (POST /oauth/token) or API Key via Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
Availability depends on the environment, enabled scopes and provider. This reference does not execute requests or collect credentials.

Parameters

No parameters declared for this operation.

Responses

201 HTTP Response

Collective invite issued.

application/json

data—Optional
metaobject | nullOptional
additionalPropertiestrue
ambientestringOptional
"homologacao" · "producao"
401 HTTP Response

Missing, invalid or cross-environment credential.

403 HTTP Response

Dashboard scope not enabled or resource outside company scope.

Complete Operation Definition
{
  "tags": [
    "Convites"
  ],
  "operationId": "emitirConviteColetivoTransportadoras",
  "summary": "Emitir código de convite coletivo para transportadoras",
  "description": "Gera um código de convite ao portador com validade de 90 dias para onboarding coletivo de transportadoras parceiras (não envia mensagens automaticamente). Exige escopo `cadastros`.",
  "responses": {
    "201": {
      "description": "Convite coletivo emitido.",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "properties": {
              "data": {
                "anyOf": [
                  {
                    "type": "object",
                    "additionalProperties": true
                  },
                  {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "additionalProperties": true
                    }
                  }
                ]
              },
              "meta": {
                "type": [
                  "object",
                  "null"
                ],
                "additionalProperties": true
              },
              "ambiente": {
                "type": "string",
                "enum": [
                  "homologacao",
                  "producao"
                ]
              }
            }
          }
        }
      }
    },
    "401": {
      "description": "Credencial ausente, inválida ou de outro ambiente."
    },
    "403": {
      "description": "Escopo do painel não habilitado ou recurso fora do escopo da company."
    }
  },
  "x-fleetpay-scope": "cadastros",
  "x-fleetpay-module": "cadastros-consultas",
  "x-fleetpay-profiles": [
    "embarcador",
    "gestor",
    "agregado_empresarial",
    "transportador_frotista"
  ],
  "method": "POST",
  "path": "/convites/transportadoras/coletivo",
  "parameters": []
}