mobilidade

Convidar condutor

Changed on

Cria vínculo pending e enfileira e-mail de convite via notify_email do body (somente proprietário). name/phone são hints opcionais enquanto pending. Duplicata pending/accepted retorna 409.

post/citizen/{cpf}/vehicles/{vehicle_id}/conductors

Request

  • Base URL: http://localhost:8080/v1
  • URL: http://localhost:8080/v1/citizen/{cpf}/vehicles/{vehicle_id}/conductors
  • Auth: API key in header Authorization

Path parameters

cpfstring required

CPF do cidadão (11 dígitos)

vehicle_idstring required

ID do veículo

Request body

cpfstring required

CPF must be exactly 11 digits (no punctuation), matching RMI/JWT form.

emailstring required
namestring
phonestring

Example request

{
  "cpf": "11144477735"
}

Response

Convite criado

conductor_cpfstring
conductor_namestring

Invite snapshot (persisted). For accepted links, GET overlays live RMI contact on these JSON fields.

created_atstring
email_attempted_atstring
email_status'pending' | 'queued' | 'sent' | 'failed' | 'skipped'
idstring
invited_by_cpfstring
notify_emailstring
phonestring
responded_atstring
status'pending' | 'accepted' | 'rejected' | 'revoked'
updated_atstring
vehicle_idstring

Changes