Appliquer un tag avec l'API Kit
Applique un tag à un abonné existant, retrouvé par son adresse e-mail. Les automatisations du compte qui démarrent avec ce tag s'exécutent pour l'abonné. Créez d'abord l'abonné avec Create subscriber.
- Identifiant
- kit_apply_tag
L'appel
POST https://connect.reportei.com/api/tools/kit_apply_tag/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"tag_id": 1,
"email_address": "<email_address>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| tag_id | integer | Oui | ID of the tag, from List tags or Create tag. |
| email_address | string | Oui | Email address of the subscriber. |
Connexions possibles
Votre client connecte son compte Kit une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/kit, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/kit_apply_tag. Il devient la définition de tool de votre agent sans conversion.
Autres tools Kit
- Lister les abonnésGETListe les abonnés avec id, e-mail, prénom, état et champs personnalisés, seulement les actifs par défaut. Recherchez-en un par email_address. La réponse contient subscribers et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.
- Créer un abonnéPOSTCrée un abonné actif. Quand l'adresse e-mail appartient déjà à un abonné, met à jour le prénom de cet abonné à la place. N'ajoute aucun tag : utilisez ensuite Apply tag.
- Mettre à jour un abonnéPUTMet à jour l'adresse e-mail, le prénom ou les champs personnalisés d'un abonné. Une clé de champ personnalisé qui n'existe pas dans le compte fait échouer la requête.
- Lister les tagsGETListe les tags avec id, nom et date de création. La réponse contient tags et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.
- Créer un tagPOSTCrée un tag et le renvoie avec son id. Quand un tag du même nom existe, sans tenir compte de la casse, renvoie ce tag au lieu d'un doublon.
- Lister les formulairesGETListe les formulaires et landing pages avec id, nom, type et URL d'intégration, seulement les actifs par défaut. La réponse contient forms et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.
- Lister les segmentsGETListe les segments avec id et nom. Les segments se construisent dans l'app Kit, et leurs ids ciblent un broadcast dans subscriber_filter. La réponse contient segments et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.
- Lister les broadcastsGETListe les broadcasts avec id, objet, contenu, statut, send_at, ciblage et modèle d'e-mail. La réponse contient broadcasts et pagination ; tant que has_next_page vaut true, passez pagination.end_cursor en after.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
