data—Opcional← InícioFleetPay / API
Emitir código de convite coletivo para transportadoras
Parâmetros, estrutura de dados e respostas do contrato versionado.
POST
/convites/transportadoras/coletivoDescrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.
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.
Autenticação
- Escopo Necessário
cadastros— Cadastros- Módulo
- Cadastros e Consultas Base
- Perfis Aplicáveis
- Embarcador · Gestor de Transporte · Agregado Empresarial · Transportador Frotista
- Mecanismos
- OAuth2 client_credentials (POST /oauth/token) ou API Key em Authorization: Bearer / X-Api-Key
[
{
"oauth2": []
},
{
"chaveApi": []
}
]A disponibilidade depende do ambiente, dos escopos habilitados e do provedor. Esta referência não executa chamadas nem recebe credenciais.
Parâmetros
Nenhum parâmetro declarado nesta operação.
Respostas
201 Resposta HTTP
Convite coletivo emitido.
application/json
metaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"homologacao" · "producao"401 Resposta HTTP
Credencial ausente, inválida ou de outro ambiente.
403 Resposta HTTP
Escopo do painel não habilitado ou recurso fora do escopo da company.
Definição Completa da Operação
{
"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": []
}