Réabonner un contact à un sujet

POST /api/v1/contacts/{contactId}/topics/{topicId}/resubscribe Réactive pour un contact les messages rattachés à un sujet. Cela ne réabonne pas globalement un contact désabonné, et tous les autres sujets restent inchangés.

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.

Paramètres de chemin

ParamètreTypeDescription
contactIdstringObligatoire. Identifiant du contact
topicIdstringObligatoire. Identifiant du sujet à réactiver

Exemple

bash
curl -X POST -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/contacts/$CONTACT_ID/topics/$TOPIC_ID/resubscribe"

Réponse

  • 200 OK — la préférence pour le sujet est subscribed, y compris quand aucun retrait n'existait.
  • 400 Bad Request — un identifiant du chemin n'est pas un UUID valide ; details désigne le 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, pas admin.
  • 404 Not Found — le contact ou le sujet est introuvable, appartient à une autre organisation, ou les deux ressources n'appartiennent pas à la même organisation.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.contactIdstringIdentifiant du contact
data.topicIdstringIdentifiant du sujet
data.statusstringToujours subscribed

Exemple de réponse

json
{
  "success": true,
  "data": {
    "contactId": "4d19c0a2-8f20-4fb8-9d55-39a88f86d778",
    "topicId": "a338c425-3115-4890-a01c-f2f6f012db93",
    "status": "subscribed"
  }
}

Remarques

  • L'appel est idempotent. Si le contact ne s'est jamais retiré du sujet, aucune ligne de préférence n'a besoin d'être créée.
  • Un retrait antérieur reste dans l'historique des préférences ; réactiver le sujet enregistre le retour au lieu d'effacer cet historique.
  • Cet appel ne change jamais le statut d'abonnement global du contact.

Voir aussi