Étiqueter des contacts depuis un autre outil
Votre boutique en ligne, Make ou Zapier pose une étiquette sur un client, un prospect ou un lead de Wodz, ou la retire, avec une clé d'API.
Un autre outil pose une étiquette sur un contact de Wodz, ou la retire. La boutique de votre site étiquette chaque acheteur du drop, Make retire l'étiquette d'un inscrit à la compétition qui se désiste. Le contact est désigné par son e-mail.
Où : Menu › Paramètres › « API », section « Étiqueter des contacts ».
La clé est la même que pour inscrire des prospects : créez-en une pour l'outil, comme l'explique Inscrire des prospects depuis un autre outil.
Poser une étiquette
| Réglage | Valeur |
|---|---|
| Méthode | POST |
| Adresse | la première de la section, qui finit par /contacts/tags |
| En-têtes | Authorization: Bearer <votre clé> et Content-Type: application/json |
| Corps | du JSON, avec les champs ci-dessous |
| Champ | Ce qu'il porte |
|---|---|
email |
Obligatoire. L'adresse du contact. |
tags |
Obligatoire. La liste des étiquettes, 20 au plus, ou une seule en texte. Un nom compte au plus 40 caractères. |
create_lead |
true pour ajouter en lead une adresse que votre salle ne connaît pas encore. |
firstname |
Obligatoire avec create_lead, sauf si full_name est donné. |
lastname |
Facultatif. |
full_name |
Le nom complet, découpé au premier espace quand firstname manque. |
dry_run |
true pour un essai. |
{
"email": "camille.martin@example.com",
"tags": ["Drop octobre", "Hyrox 22/11"]
}
Une étiquette qui n'existe pas encore est créée, avec le nom envoyé. Sur la page « Étiquettes », sa ligne dit qu'elle a été créée par l'API, avec le nom de la clé. Un nom qui ne diffère d'une étiquette existante que par les majuscules ou les accents désigne cette étiquette : hyrox pose « Hyrox ».
Une personne peut avoir plusieurs fiches, par exemple cliente et encore prospect. L'étiquette va sur sa fiche client, sinon sur sa fiche prospect, sinon sur sa fiche lead. Au survol de la pastille, la fiche dit qu'elle a été posée par l'API, avec le nom de la clé.
Envoyer deux fois le même appel ne pose rien de plus : l'étiquette déjà là est signalée already.
Une adresse que la salle ne connaît pas
Par défaut, Wodz la refuse : rien n'est créé, ni contact ni étiquette. Une faute de frappe dans l'adresse ne fabrique pas de fiche.
Avec "create_lead": true et le prénom, Wodz ajoute un lead à votre salle, puis l'étiquette. C'est le cas d'un acheteur de la boutique qui n'est pas encore adhérent.
Point d'attention. Un lead reçoit vos newsletters, comme un lead importé, jusqu'à ce qu'il se désinscrive depuis un e-mail. N'envoyez
create_leadque pour des personnes qui vous ont acheté quelque chose ou donné leur adresse.
Retirer une étiquette
Même appel, à la seconde adresse de la section, qui finit par /contacts/tags/remove. Le corps porte email, tags et, pour un essai, dry_run.
L'étiquette est retirée de toutes les fiches de la personne : une newsletter rapproche les étiquettes par adresse, et une fiche oubliée la viserait encore. Une étiquette inconnue n'est pas créée : elle est signalée unknown.
Faire un essai
Ajoutez "dry_run": true au corps. Wodz vérifie la clé et les champs, retrouve le contact, puis répond ce qu'il ferait, sans rien poser ni retirer. Avec create_lead, la réponse annonce le lead à créer, sans identifiant.
Lire la réponse
Pour une pose :
{
"result": "tagged",
"contact": { "type": "subscriber", "id": 4812, "created": false },
"tags": [
{ "name": "Drop octobre", "status": "added", "created": true },
{ "name": "Hyrox 22/11", "status": "already", "created": false }
]
}
| Champ | Ce qu'il dit |
|---|---|
contact.type |
La fiche étiquetée : subscriber (client), prospect ou lead. |
contact.created |
true pour un lead que l'appel vient de créer. |
tags[].status |
added : posée maintenant. already : le contact la portait déjà. |
tags[].created |
true pour une étiquette que l'appel vient de créer. |
Pour un retrait, result vaut removed et chaque étiquette a un status : removed (retirée), absent (le contact ne la portait pas) ou unknown (aucune étiquette de ce nom dans votre salle).
| Code HTTP | Valeur | Ce qui s'est passé |
|---|---|---|
| 200 | tagged |
Étiquettes posées sur un contact connu. |
| 201 | tagged |
Lead créé avec create_lead, puis étiqueté. |
| 200 | removed |
Retrait fait. |
| 200 | dry_run |
Essai, rien n'a changé. |
| 401 | missing_key, invalid_key |
Clé absente, inconnue ou révoquée. |
| 404 | contact_not_found |
Aucun contact de votre salle n'a cette adresse. |
| 422 | tag_limit_reached |
Votre salle a déjà 200 étiquettes : celles à créer sont dans error.tags. Rien n'a été posé. |
| 422 | validation |
Un champ manque ou est invalide : error.fields le nomme. |
| 429 | rate_limited |
Plus de 120 appels en une minute, ou 2 000 en un jour, avec cette clé, prospects compris. Réessayez après le délai de Retry-After. |
| 429 | too_many_failed_attempts |
Trop d'appels refusés depuis la même adresse. |
La valeur est dans result pour un appel réussi, dans error.code pour une erreur. error.message l'explique en français.
Exemple : les acheteurs d'un drop
Dans Make, un scénario part de la commande payée sur votre boutique en ligne. Le module « HTTP › Make a request » envoie à Wodz l'e-mail de l'acheteur, l'étiquette Drop octobre, "create_lead": true et son nom.
À la fin du drop, la newsletter de remerciement part au public « Étiquettes », Drop octobre coché. La relance des retardataires part à tous vos clients, en excluant cette étiquette. Voir Choisir qui reçoit une newsletter.
Un remboursement retire l'étiquette avec le second appel : l'acheteur ne reçoit plus le remerciement, et retrouve la relance.