← InicioFleetPay / API

Emitir código de invitación colectiva para transportistas

Parámetros, estructura de datos y respuestas del contrato versionado.

POST/convites/transportadoras/coletivo
emitirConviteColetivoTransportadorasBase de Pruebas: https://api.fleetpay.site/v1

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

Genera un código de invitación al portador con validez de 90 días para el alta colectiva de transportistas asociados (no envía mensajes automáticamente). Requiere el permiso cadastros.

Autenticación

Permiso Requerido
cadastros — Registros
Módulo
Registros y Consultas Base
Perfiles Aplicables
Embarcador · Gestor de Transporte · Agregado Empresarial · Transportista Flotista
Mecanismos
OAuth2 client_credentials (POST /oauth/token) o API Key vía Authorization: Bearer / X-Api-Key
[
  {
    "oauth2": []
  },
  {
    "chaveApi": []
  }
]
La disponibilidad depende del entorno, los permisos habilitados y el proveedor. Esta referencia no ejecuta solicitudes ni recibe credenciales.

Parámetros

No hay parámetros declarados para esta operación.

Respuestas

201 Respuesta HTTP

Invitación colectiva emitida.

application/json

data—Opcional
metaobject | nullOpcional
additionalPropertiestrue
ambientestringOpcional
"homologacao" · "producao"
401 Respuesta HTTP

Credencial ausente, inválida o de otro entorno.

403 Respuesta HTTP

Permiso del panel no habilitado o recurso fuera del alcance de la company.

Definición Completa de la Operación
{
  "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": []
}