Criar Invite

Cria um invite de vídeo-acordo para um cliente e script da conta.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Formato das datas

Data e hora sem timezone embutido. O fuso vem no campo separado timezone do payload.

📌 Formato: YYYY-MM-DDTHH:mm:ss

Exemplos válidos:

2025-03-29T17:21:00        + "timezone": "America/Sao_Paulo"
2025-03-29T17:21:00        + "timezone": "UTC"

Explicação:

  • 2025-03-29 → Data (AAAA-MM-DD)
  • T → separador entre data e hora
  • 17:21:00 → hora, minutos e segundos (HH:mm:ss)
  • Sem sufixo Z e sem offset ±HH:MM — inclualhar.
  • O fuso é definido pelo campo timezone; ausente → U

Campos do script

Caso algum campo (variável) exista no script criado e não tenha sido enviado no payload dessa requisição, ocorrerá um erro na criação do invite. Ex: "meu nome é {{name}} e tenho {{age}}". Se as label's e value's de "name" ou "age" não forem enviadas, ocorrerá um erro.

  • Em script.fields, é preenchido os dados que serão incluidos nas mensagens do script.
    • Sobre os formatos:
      • ⚠️⚠️⚠️ CPF: Recomendamos o formato 111.222.333-44 para auxiliar a leitura do documento por parte da I.A

🚧

Biometria habilitada na jornada

Quando a biometria estiver habilitada na jornada, e no payload de envio estiver o campo identificationImage, um erro de validação será retornado ao tentar criar o invite.

Body Params
string

Data de quando o invite estará disponível para utilização. Se não informado, a data de criação do invite será usada. Formato ISO 8601 com milissegundos

customer
object
required
string
required

Data de expiração do invite (ISO 8601 com milissegundos)

script
object
required
string

Se não informado, o default será America/Sao_Paulo

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json