Criar Convite

URL

POST <https://acesso.production.evoluttohomolog.com.br/api/v1/contratos/convites/convite.json>

Payload de Requisição

{
    "nome_convidado": "João da Silva",
    "email_convidado": "[email protected]",
    "papel_convidado": 3,
    "restringir_login": false,
    "contratos": [
        {
            "produto": 12345,
            "consultor_responsavel": 1234567,
            "contrato_inicio": "2025-02-01",
            "contrato_fim": "2026-01-31",
            "freemium": false,
            "empresa_nome_ou_id": "123456",
            "ativo_consultoria": true,
            "habilitar_chat": true,
            "habilitar_chamado": true,
            "modo_demonstracao": false
        }
    ],
    "organizacao": 1234,
    "integrations": {}
}

Campo

Tipo

Descrição

nome_convidado

string

Nome do convidado a ser registrado.

email_convidado

string

E-mail do convidado. Ex: "[email protected]".

papel_convidado

int

Código do papel a ser atribuído ao convidado. 1 - especialista responsável 2 - especialista assistente 3 - interlocutor responsável 4 - interlocutor assistente

restringir_login

boolean

Se verdadeiro, o convidado só poderá aceitar aceitar o convite informando o e-mail informado no campo email_convidado

contratos[].produto

int

Identificador do produto ao qual o contrato se refere.

contratos[].consultor_responsavel

int

Identificador do consultor responsável.

contratos[].contrato_inicio

string (Data)

Data de início do contrato no formato YYYY-MM-DD.

contratos[].contrato_fim

string (Data)

Data de término do contrato no formato YYYY-MM-DD.

contratos[].freemium

boolean

Indica se o projeto é freemium (gratuito).

contratos[].empresa_nome_ou_id

string

Identificador da empresa cliente do projeto. “Aqui entra o ID obtido no passo 1 - Criar cliente”

contratos[].ativo_consultoria

boolean

Se verdadeiro, ativa a consultoria no contrato.

contratos[].habilitar_chat

boolean

Se verdadeiro, habilita o chat no projeto.

contratos[].habilitar_chamado

boolean

Se verdadeiro, habilita o sistema de chamados no projeto.

contratos[].modo_demonstracao

boolean

Se verdadeiro, habilita o modo de demonstração no projeto.

organizacao

int

Identificador da organização responsável pelo convite.

integrations

object

— **Obsoleto —**Campos adicionais de integração.

Exemplo de Resposta

{
    "mensagem": "Convite Criado com sucesso",
    "empresa_usuario_convite": {
        "id": 224610,
        "empresa": null,
        "token": "kXCkPuXVUj",
        "nome": "João da Silva",
        "email": "[email protected]",
        "convidado_por": {
            "id": 1234567,
            "nome": "John Doe",
            "emails": [
                {
                    "email": "[email protected]",
                    "principal": true
                }
            ]
        },
        "url_aceite": "<https://acesso.production.evoluttohomolog.com.br/convite/kXCkPuXVUj/>"
    }
}

Campo

Tipo

Descrição

mensagem

string

Mensagem indicando o status da operação.

empresa_usuario_convite.id

int

Identificador do convite criado.

empresa_usuario_convite.token

string

Token de convite único gerado para o convidado.

empresa_usuario_convite.url_aceite

string

URL onde o convidado poderá aceitar o convite.

empresa_usuario_convite.convidado_por.nome

string

Nome da pessoa que enviou o convite.

empresa_usuario_convite.convidado_por.emails[].email

string

E-mail do responsável pelo convite.


Updated on