Esta seção da documentação descreve detalhadamente os campos utilizados nas requisições e respostas da API, juntamente com as regras de negócio associadas a cada um deles. Aqui, você encontrará informações sobre:
- Definições dos campos: Nome, tipo de dado e formato esperado.
- Validações aplicadas: Regras obrigatórias, valores permitidos, e limites de tamanho ou intervalo.
- Dependências e relações: Campos que dependem de outros ou influenciam o comportamento da API.
- Comportamento padrão: Valores atribuídos automaticamente e tratamento de dados opcionais.
Nosso objetivo é garantir que você tenha uma compreensão clara de como interagir com os campos da API e evitar erros comuns durante a integração. Certifique-se de consultar esta seção ao construir ou validar suas requisições.
Campos e Regras de Negócio:
Descrição dos Campos
| Campo | Descrição | Tipo |
|---|---|---|
| role | Define o nível de acesso do usuário a funcionalidades da conta | string |
| consumption_accessible | Define se o usuário vai ter acesso à página de cobrança | boolean |
| tracking_accessible | Define se o usuário vai ter acesso à página de e-mails enviados | boolean |
Regras dos campos para a Criação
Campo | Obrigatório | Disponível | Valor Padrão |
|---|---|---|---|
role | SIM | SIM | |
consumption_accessible | NÃO | SIM | false |
tracking_accessible | NÃO | SIM | false |
Conte com a nossa ajuda!
Estamos comprometidos em fornecer a você todas as ferramentas necessárias para simplificar e aprimorar seus processos de assinatura eletrônica. Não hesite em nos contatar se tiver alguma dúvida ou precisar de assistência adicional. Estamos sempre disponíveis através do e-mail [email protected].