Skip to main content
POST
Criar corrida programada

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

api-key
string
header
required

Obrigatório. Sua chave API.

Body

application/json
data
string
required

Data da corrida programada em DD/MM/YYYY.

hora
string
required

Hora da corrida programada.

dados_cadastro
object
required
dados_passageiro
object
required
forma_pagamento
string
required
partida
object
required
antecedencia
integer
id_externo
empresa
object
info_antes_aceite
string
info_apos_aceite
string
categoria_id
integer
categoria_nome
string
estimativas
boolean
ignorar_condutores_proximos
boolean
chat_ativo
boolean
default:false

Envie true para habilitar o chat da corrida. Sem ele a corrida não tem chat: os endpoints de mensagem recusam, e o condutor não vê a caixa de texto no app. A marca vale para a corrida criada quando a programada for disparada, e as mensagens são enviadas por POST /mensagens/corridas/passageiro e lidas por GET /mensagens/corridas/passageiro/{solicitacao_id}.

extras
object
condutor
object
desejado
object
paradas
object[]

Lista de paradas da corrida. Limite máximo de 1000 itens.

Maximum array length: 1000
retorno
boolean
codigo_cupom
string

Código do cupom de desconto a ser aplicado na corrida.

Response

200 - application/json

Corrida programada criada com sucesso. passageiro_id e condutor_id identificam as pessoas da programada e valem para a corrida que ela gerar no disparo; condutor_id só aparece quando a programada já nasce com um condutor definido. chat_ativo só aparece quando você enviou o campo na criação, e quando vier false, chat_ativo_motivo diz por quê: PASSAGEIRO_POSSUI_APP, quando o passageiro da corrida já usa o aplicativo e a conversa acontece por ele, ou FALHA_AO_REGISTRAR, quando não conseguimos habilitar o chat. A corrida vale nos dois casos.

The response is of type object.