Atualizar conteúdo do e-mail de boas-vindas personalizado

Versão 4.0.23.6 (mais recente)

Atualizar configurações e valores personalizados do e-mail de boas-vindas. Opcionalmente, envie um e-mail de teste com o novo conteúdo ao usuário conectado no momento.

Solicitação

PATCH /custom_welcome_email
Tipo de dados
Descrição
Solicitação
HTTPRequest
body
Corpo HTTP
Expandir definição HTTPBody...
body
Configuração "E-mail de boas-vindas personalizado" e valor para salvar
Expandir definição de CustomWelcomeEmail...
ativado
booleano
Se verdadeiro, o conteúdo do e-mail personalizado substituirá o corpo padrão dos e-mails de boas-vindas
conteúdo
string
O HTML a ser usado como conteúdo personalizado para e-mails de boas-vindas. Os elementos de script e outras marcações potencialmente perigosas serão removidos.
subject
string
O texto a ser exibido na linha de assunto do e-mail. Disponível apenas com uma licença de etiqueta em branco e whitelabel_configuration.advanced_custom_welcome_email ativado.
cabeçalho
string
O texto a ser exibido na linha de cabeçalho do corpo do e-mail. Disponível apenas com uma licença de etiqueta em branco e whitelabel_configuration.advanced_custom_welcome_email ativado.
consulta
Consulta HTTP
Expandir a definição de HTTPQuery...
enviar_e-mail_de_boas-vindas
booleano
Se verdadeiro, um e-mail de teste com o conteúdo da solicitação será enviado ao usuário atual após ser salvo.

Resposta

200: e-mail de boas-vindas personalizado

Tipo de dados
Descrição
(objeto)
ativado
booleano
Se verdadeiro, o conteúdo do e-mail personalizado substituirá o corpo padrão dos e-mails de boas-vindas
conteúdo
string
O HTML a ser usado como conteúdo personalizado para e-mails de boas-vindas. Os elementos de script e outras marcações potencialmente perigosas serão removidos.
subject
string
O texto a ser exibido na linha de assunto do e-mail. Disponível apenas com uma licença de etiqueta em branco e whitelabel_configuration.advanced_custom_welcome_email ativado.
cabeçalho
string
O texto a ser exibido na linha de cabeçalho do corpo do e-mail. Disponível apenas com uma licença de etiqueta em branco e whitelabel_configuration.advanced_custom_welcome_email ativado.

400: Solicitação inválida

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

404: não encontrado

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação

422: erro de validação

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
Expandir a definição de ValidationErrorDetail...
campo
string
Campo com erro
código
string
Código do erro
mensagem
string
Mensagem de erro
url_da_documentação
string
Link da documentação
url_da_documentação
string
Link da documentação

429: Solicitações demais

Tipo de dados
Descrição
(objeto)
mensagem
string
Detalhes do erro
url_da_documentação
string
Link da documentação