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
message	Determina a mensagem personalizada que será enviada ao signatário.	string
email_customization	Determina atributos que customizam a notificação por email	json
email_customization.subject	Determina assunto do email. (Máx: 998 chars).	string
email_customization.head	Determina o cabeçalho da notificação, presente no corpo do email. (Máx: 3000 chars).	string
email_customization.greeting	Determina a saudação da notificação, presente no corpo do email. (Máx: 3000 chars).	string
email_customization.principal	Determina a mensagem principal da notificação, presente no corpo do email. (Máx: 3000 chars).	string
email_customization.button	Determina o texto no botão que direciona o signatário à assinatura. (Máx: 50 chars).	string
email_customization.final	Determina a mensagem final após o botão, presente no corpo do email. (Máx: 3000 chars).	string
email_customization.align	Determina o alinhamento dos elementos do email.	string
email_customization.show_token	Determina se o Token é exibido no corpo do email (quando existir autenticação por token)	boolean
email_customization.show_qrcode	Determina se é adicionado um QR Code ao corpo do email, o conteúdo do QR Code é o link para assinatura.	boolean
email_customization.show_details	Determina se devem ser exibidos detalhes do processo de assinatura, impresso após todas as mensagens.	boolean

Regras de Negócio para os campos

Campo	Regras de Negócio
message	Esse atributo pode ser customizado em caso de notificações por `email`. Em casos de notificações por `whatsapp` ou `sms`, o campo `message` é desconsiderado. - Quando nenhuma mensagem for enviada, será utilizado o dado existente no `#default_message` do envelope .
email_customization	Esse atributo pode ser customizado em caso de notificações por `email`. Em casos de notificações por `whatsapp` ou `sms`, o campo `message` é desconsiderado.
email_customization.align	Aceita os valores `left`, `center`, `right`, `justify`

Regras dos campos para a Criação

Campo	Obrigatório	Disponível	Valor Padrão
message	NÃO	SIM	null
email_customization	NÃO	SIM	{}
email_customization.subject	NÃO	SIM	null
email_customization.head	NÃO	SIM	null
email_customization.greeting	NÃO	SIM	null
email_customization.principal	NÃO	SIM	null
email_customization.button	NÃO	SIM	'Visualizar para assinar'
email_customization.final	NÃO	SIM	null
email_customization.align	NÃO	SIM	center
email_customization.show_token	NÃO	SIM	false
email_customization.show_qrcode	NÃO	SIM	false
email_customization.show_details	NÃO	SIM	true

❓Precisa de ajuda? Entre em contato com o Suporte

💰Dúvida sobre planos e preços? Veja o comparativo

🔍Não sabe qual versão está usando? Descubra a sua versão

📚Respostas rápidas? Visite nosso FAQ