Sign in

v1

latestOpenAPI 3.1.02026-07-24174964.1 KB
Invites

Criar Invite

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

post/api/v1/account/invite

Request body

availableAtstring

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

expiresAtstring required

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

timezonestring

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

Example request

{
  "availableAt": "2025-03-29T17:21:00.000",
  "customer": {
    "cpf": "12345678901",
    "fields": [
      {
        "label": "email",
        "value": "cliente@exemplo.com"
      }
    ],
    "name": "Maria Silva"
  },
  "expiresAt": "2025-04-29T23:59:59.000",
  "script": {
    "fields": [
      {
        "displayName": "Nome da empresa",
        "label": "empresa",
        "value": "Nuvidio"
      }
    ],
    "id": "878a4881-8fd3-46ce-91ad-06f37256b62e"
  },
  "timezone": "America/Sao_Paulo"
}

Response

Invite criado com sucesso

accountIdstring

Conta associada (quando retornado)

availableAtstring

Início de disponibilidade efetivo do invite

customerJourneyTypestring

Tipo de jornada do script (ex.: agreement)

expiredInviteUrlstring

URL quando o invite expirar

expiresAtstring

Expiração do invite

helpUrlstring

URL de ajuda

invalidDataUrlstring

URL para dados inválidos no fluxo

inviteIdstring

ID do invite criado

inviteUrlstring

URL do convite para o cliente

successUrlstring

URL de sucesso ao finalizar

termsUrlstring

URL dos termos

timezonestring

Timezone aplicado

voiceGenderstring

Gênero de voz da IA quando aplicável

Example response

{
  "accountId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "availableAt": "2025-03-29T17:21:00Z",
  "customerJourneyType": "agreement",
  "expiresAt": "2025-04-29T23:59:59Z",
  "inviteId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "inviteUrl": "https://app.exemplo.com/invite/abc",
  "timezone": "America/Sao_Paulo",
  "voiceGender": "female"
}