Modifier les réglages d'inscription

PATCH /api/v1/settings/optin Le double opt-in et l'e-mail de confirmation. Rôle admin requis. Le réglage de l'organisation décide seul des nouvelles inscriptions. Activé : pending avec un e-mail de confirmation. Désactivé : subscribed sans confirmation. L'API des contacts accepte l'ancien booléen doubleOptIn mais l'ignore, qu'il vaille true ou false.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Corps de la requête

ChampTypeObligatoireDescription
requiredbooleannontrue : les nouvelles inscriptions sont pending avec confirmation ; false : subscribed sans confirmation
subjectstringnonObjet de l'e-mail de confirmation
contentstringnonSon HTML — rejeté sans {{confirmationUrl}}
json
{"required": true}

Exemple

bash
curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"required": true}' \
  "https://www.agentsmail.io/api/v1/settings/optin"

Réponse

  • 200 OK — l'appel a réussi.
  • 400 Bad Request — la validation a échoué ; details porte les erreurs champ par champ.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Un contenu identique à celui par défaut est stocké vide, pour que l'organisation continue d'hériter de ses améliorations futures. C'est ce que vous indique customized.
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.requiredbooleanSi la confirmation est désormais exigée
data.subjectstringL'objet en vigueur
data.contentstringLe HTML en vigueur
data.customizedbooleanfalse signifie que les deux sont encore les valeurs par défaut du produit

Exemple de réponse

json
{
  "success": true,
  "data": {"required": true, "subject": "Confirm your subscription", "content": "<html>…{{confirmationUrl}}…</html>", "customized": true}
}

Remarques

  • Changer ce réglage ne modifie pas le statut des contacts existants.
  • Les imports conservent le statut déclaré et n'envoient jamais d'e-mail de confirmation.

Voir aussi