Mettre à jour le contenu de l'e-mail de bienvenue personnalisé

Version 4.0.23.6 (la plus récente)

Modifiez le paramètre et les valeurs de l'e-mail de bienvenue personnalisé. Vous pouvez éventuellement envoyer un e-mail de test avec le nouveau contenu à l'utilisateur actuellement connecté.

Demande

PATCH /custom_welcome_email
Type de données
Description
Demande
HTTPRequest
body
Corps HTTP
Développer la définition HTTPBody...
body
Paramètre d'e-mail de bienvenue personnalisé et valeur à enregistrer
Développer la définition de CustomWelcomeEmail...
activé
booléen
Si la valeur est "true", le contenu de l'e-mail personnalisé remplacera le corps par défaut des e-mails de bienvenue
contenu
string
Code HTML à utiliser comme contenu personnalisé pour les e-mails de bienvenue. Les éléments de script et les autres balises potentiellement dangereuses seront supprimés.
subject
string
Texte à afficher dans la ligne d'objet de l'e-mail. Disponible uniquement avec une licence en marque blanche et avec l'option "whitelabel_configuration.advanced_custom_welcome_email" activée.
en-tête
string
Texte à afficher dans l'en-tête du corps de l'e-mail. Disponible uniquement avec une licence en marque blanche et avec l'option "whitelabel_configuration.advanced_custom_welcome_email" activée.
query
Requête HTTP
Développer la définition de la requête HTTP...
envoyer un e-mail de bienvenue pour le test
booléen
Si la valeur est définie sur "true", un e-mail test contenant le contenu de la demande sera envoyé à l'utilisateur actuel après l'enregistrement

Réponse

200: E-mail de bienvenue personnalisé

Type de données
Description
activé
booléen
Si la valeur est "true", le contenu de l'e-mail personnalisé remplacera le corps par défaut des e-mails de bienvenue
contenu
string
Code HTML à utiliser comme contenu personnalisé pour les e-mails de bienvenue. Les éléments de script et les autres balises potentiellement dangereuses seront supprimés.
subject
string
Texte à afficher dans la ligne d'objet de l'e-mail. Disponible uniquement avec une licence en marque blanche et avec l'option "whitelabel_configuration.advanced_custom_welcome_email" activée.
en-tête
string
Texte à afficher dans l'en-tête du corps de l'e-mail. Disponible uniquement avec une licence en marque blanche et avec l'option "whitelabel_configuration.advanced_custom_welcome_email" activée.

400 Bad Request

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

404: introuvable

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation

422: Erreur de validation

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
Développer la définition de ValidationErrorDetail...
champ
string
Champ comportant une erreur
code
string
Code d'erreur
Message
string
Message d'information sur l'erreur
documentation_url
string
Lien vers la documentation
documentation_url
string
Lien vers la documentation

429 : Too Many Requests

Type de données
Description
(objet)
Message
string
Infos sur l'erreur
documentation_url
string
Lien vers la documentation