Aller au contenu
subagentdocs
Sommaire de la documentation

Documentation › Outils › remove_audience_contact

remove_audience_contact

Voir en .md

Retire l’adresse d’une audience.

En bref

PropriétéValeur
TitreRetirer un contact de l’audience
Outil MCPremove_audience_contact, sur https://api.subagent.fr/mcp
Appel HTTPPOST https://api.subagent.fr/v1/remove_audience_contact
Accèspermission send
État de l’espacevérifié : sinon, refus space_unverified
Effetécriture
Vue dans l’assistantoui : voir Vues

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Retire l’adresse d’une audience. Les campagnes déjà programmées gardent leur liste ; pour arrêter tout envoi, utiliser add_suppression.

Paramètres

remove_audience_contact accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.

ParamètreTypeObligatoireDescription
audience_ididentifiant aud_…ouiAudience.
emailtexteouiAdresse exacte.

Résultat

L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.

ChampTypeContenu
removedbooléenLe contact est retiré de l’audience.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/remove_audience_contact \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "aud_3c8f1a5e9d2b47c6a0e4f81b7d5c9e26",
  "email": "marc.lefevre@exemple.com"
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_audience_contact",
    "arguments": {
      "audience_id": "aud_3c8f1a5e9d2b47c6a0e4f81b7d5c9e26",
      "email": "marc.lefevre@exemple.com"
    }
  }
}

Refus possibles

CodeHTTPCe qui s’est passéQue faire
audience_scope403Les audiences demandent un accès à toutes les boîtes de l’espace ; cette clé est limitée à certaines.Passer par une clé qui accède à tout l’espace, ou par l’assistant de l’humain.

S’y ajoutent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

Voir aussi

Cette page en Markdown : /docs/reference/remove_audience_contact.md Toute la documentation pour un agent : /llms.txt Mentions légales · Conditions de vente · Confidentialité · Signaler un abus