---
title: "Criar Invite com Multi Case"
method: POST
path: "/video-agreement/api/v1/account/multicase/invite"
deprecated: true
---

# Criar Invite com Multi Case

`POST /video-agreement/api/v1/account/multicase/invite`

## Request

- Base URL: `https://apigw.nuvidio.com`
- URL: `https://apigw.nuvidio.com/video-agreement/api/v1/account/multicase/invite`
- Auth: OAuth 2

> **Deprecated.**

## Request body

- object
  - `availableAt` string: Data de quando o invite estará disponível para utilização. Se não informado, a data de criação do invite será usado. Exemplo: 2025-03-29T17:21:00.000
  - `expiresAt` string, required: Data de expiração do invite.
  - `timezone` string: Se não informado, o default será America/Sao_Paulo.
  - `customer` object, required: Campos relacionados ao cliente que realizará o vídeo agreement.
    - `cpf` string, required: CPF do cliente que realizará a vídeo declaração.
    - `fields` object[]: Lista de campos que serão (ou não) exibidos no front-end.
      - `label` string, required: Nome do campo que será exibido (ou não) no front-end.
      - `value` string, required: Valor do campo que será exibido (ou não) no front-end.
      - `private` boolean: Caso seja privado, não será exibido no front-end, mas será enviado para a empresa ao final do fluxo de video-agreement.
    - `name` string, required: Nome do cliente que realizará a vídeo declaração.
    - `identificationImage` string: Imagem (base64 ou URL) para auxiliar na identificação do cliente que realizará a vídeo declaração. Ex: Selfie, RG, CNH
  - `script` object, required: Campos relacionados aos scripts.
    - `journey` object: Informações relacionadas ao script principal que serve como base da jornada do cliente.
      - `scriptReference` string, required: Informe a referência do script que deve ser incorporado ao fluxo caso as condições sejam atendidas. Essa referência pode ser um script_id ou um reference válido. Exemplo 1: 878a4881-8fd3-46ce-91ad-06f37256b62e Exemplo 2: script_cartao_2
      - `fields` object[]: Lista de pares chave-valor utilizados para substituir variáveis no script. Exemplo: se o script contém a mensagem "Essa é a {{empresa}}", ao definir a chave empresa nesta lista com o valor Nuvidio, a mensagem final será exibida como "Essa é a Nuvidio".
        - `label` string, required: Label da variável que consta no script.
        - `value` string, required: Valor da variável que consta no script. Na criação do roteiro ocorrerá a troca do que consta {{label}} pelo value informado.
        - `displayName` string: Nome amigável que poderá ser exibido no frontend sempre que necessário.
    - `cases` object[]: Lista de scripts que o cliente poderá (ou não) percorrer ao longo da jornada do invite.
      - `Identifier` string: Identificador utilizado para controle e agrupamento. Caso não seja informado, um valor aleatório será gerado automaticamente. Exemplos: Produto XPTO, Proposta 4547.
      - `scriptReference` string, required: Informe a referência do script que deve ser incorporado ao fluxo caso as condições sejam atendidas. Essa referência pode ser um script_id ou um reference válido. Exemplo 1: 878a4881-8fd3-46ce-91ad-06f37256b62e Exemplo 2: script_cartao_2
      - `fields` object[]: Lista de pares chave-valor utilizados para substituir variáveis no script. Exemplo: se o script contém a mensagem "Essa é a {{empresa}}", ao definir a chave empresa nesta lista com o valor Nuvidio, a mensagem final será exibida como "Essa é a Nuvidio".
        - `label` string, required: Label da variável que consta no script.
        - `value` string, required: Valor da variável que consta no script. Na criação do roteiro ocorrerá a troca do que consta {{label}} pelo value informado.
        - `displayName` string: Nome amigável que poderá ser exibido no frontend sempre que necessário.
        - `private` boolean: Informe private como True se é um campo de controle que deseja receber de volta ao final do processamento da jornada.

## Response `200`

200

- object
  - `availableAt` string
  - `expiresAt` string
  - `inviteId` string
  - `inviteUrl` string
  - `expiredInviteUrl` string
  - `invalidDataUrl` string
  - `termsUrl` string
  - `helpUrl` string
  - `successUrl` string
  - `timezone` string
  - `customerJourneyType` string
  - `voiceGender` string

## Other responses

- `400`: 400
- `422`: 422
- `500`: 500

---

[API](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2.md) - [All operations](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/nuvidio/apis/gateway-nuvidio-v2/revisions/c488e657f07b?raw)