← HomeFleetPay / Schema

Convite

Structure preserved from the versioned API contract.

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

documentostringRequired

Invited tax identifier, digits only.

telefonestringOptional

Normalized mobile number. Absent when the carrier had already been invited.

statusstringRequired

convite_enviado — the message was sent. ja_convidada — an invitation already existed and nothing new was sent. registrado_envio_pendente — the invitation was recorded, but sending the message failed; FleetPay retries delivery, so do not repeat the request.

"convite_enviado" · "ja_convidada" · "registrado_envio_pendente"

convidada_emstringOptional

When the invitation was recorded.

proximo_passostringRequired

Text describing what happens next.

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "documento",
    "status",
    "proximo_passo"
  ],
  "properties": {
    "documento": {
      "type": "string",
      "description": "O documento convidado, somente digitos."
    },
    "telefone": {
      "type": "string",
      "description": "O celular normalizado. Ausente quando a transportadora ja havia sido convidada."
    },
    "status": {
      "type": "string",
      "enum": [
        "convite_enviado",
        "ja_convidada",
        "registrado_envio_pendente"
      ],
      "description": "`convite_enviado` — a mensagem saiu. `ja_convidada` — ja existia convite e nada novo foi enviado. `registrado_envio_pendente` — o convite ficou registrado mas o envio da mensagem falhou; a FleetPay reenvia, nao repita a chamada."
    },
    "convidada_em": {
      "type": "string",
      "description": "Quando o convite foi registrado."
    },
    "proximo_passo": {
      "type": "string",
      "description": "Em texto, o que acontece a seguir."
    }
  }
}