data—Opcional← InicioFleetPay / API
Emitir código de invitación colectiva para conductores
Parámetros, estructura de datos y respuestas del contrato versionado.
POST
/convites/motoristasLas descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.
Emite código de invitación reutilizable al portador (validez de 90 días) vinculando nuevos conductores al transportista emisor sin envío activo de mensajes. 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 de conductores emitida.
application/json
metaobject | nullOpcionaladditionalPropertiestrueambientestringOpcional"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": "emitirConviteColetivoMotoristas",
"summary": "Emitir código de convite coletivo para motoristas",
"description": "Emite código de convite reutilizável ao portador (validade de 90 dias) vinculando novos motoristas à transportadora emissora sem envio ativo de mensagens. Exige escopo `cadastros`.",
"responses": {
"201": {
"description": "Convite coletivo de motoristas 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/motoristas",
"parameters": []
}