Logo Site EngageLab Mark Colored TransparentDocumentation
Email
Accueil de la Documentation
Démarrage rapideInstructionsREST APISMTPUseMarketingWebHookTéléchargement de ressources
Rechercher
Connexion
REST API/Marketing/Gestion des Étiquettes de Campagne
REST APIMarketingGestion des Étiquettes de Campagne...

Gestion des Étiquettes de Campagne

Dernière Mise à jour：24 days ago

Point de terminaison (Endpoint)

Centre de données URL
Singapour https://email.api.engagelab.cc
Turquie https://emailapi-tr.engagelab.com

Lors de l'utilisation de l'API REST, combinez l'URL de base sélectionnée avec le chemin de l'API spécifique pour obtenir l'URL complète du point de terminaison.

POST/v1/marketing/campaigns/tags

Créer des étiquettes de campagne

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

POST
              
              POST
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Paramètres du corps (Body Parameters)

Parameter Type Required Description
tag_names array[string] true Noms des étiquettes. Longueur maximale : 64 caractères. Seuls les caractères a-z, A-Z, 0-9, _, les caractères chinois, etc. sont pris en charge.

Remarques :

  1. Chaque organisation peut créer jusqu'à 100 étiquettes.

  2. Les noms des étiquettes doivent être uniques.

Exemple de requête (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{ "tag_names": ["promotion_black_friday", "nouveaux_utilisateurs"] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags) --data '{
    "tag_names": ["promotion_black_friday", "nouveaux_utilisateurs"]
}'
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 32603, "message": "tag name already exist" }
              
              {
    "code": 32603,
    "message": "tag name already exist"
}
Afficher ce bloc de code dans la fenêtre flottante

Liste des étiquettes de campagne

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

GET
              
              GET
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Paramètres de requête (Query Parameters)

Parameter Type Required Description
tag_name string false Nom de l'étiquette (recherche floue)
offset integer false Décalage de l'enregistrement. Plage de valeurs : [0-]. Par défaut : 0
limit integer false Nombre d'enregistrements à récupérer. Plage de valeurs : [1-100]. Par défaut : 10

Exemple de requête (Request Example)

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promotion&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promotion&limit=10&offset=0)
              
              curl -X GET -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promotion&limit=10&offset=0](https://email.api.engagelab.cc/v1/marketing/campaigns/tags?tag_name=promotion&limit=10&offset=0)
Afficher ce bloc de code dans la fenêtre flottante

Champs de réponse (Response Fields)

Parameter Type Description
tag_id string ID de l'étiquette
tag_name string Nom de l'étiquette
create_time string Heure de création
update_time string Heure de mise à jour

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "result": [ { "tag_id": "64a1f2e0c9e1a23456789012", "tag_name": "promotion_black_friday", "create_time": "2024-01-15T10:30:00+0800", "update_time": "2024-01-16T14:20:00+0800" }, { "tag_id": "64a1f2e0c9e1a23456789013", "tag_name": "nouveaux_utilisateurs", "create_time": "2024-01-14T08:00:00+0800", "update_time": "2024-01-14T08:00:00+0800" } ], "total": 2, "count": 2 }
              
              {
    "result": [
        {
            "tag_id": "64a1f2e0c9e1a23456789012",
            "tag_name": "promotion_black_friday",
            "create_time": "2024-01-15T10:30:00+0800",
            "update_time": "2024-01-16T14:20:00+0800"
        },
        {
            "tag_id": "64a1f2e0c9e1a23456789013",
            "tag_name": "nouveaux_utilisateurs",
            "create_time": "2024-01-14T08:00:00+0800",
            "update_time": "2024-01-14T08:00:00+0800"
        }
    ],
    "total": 2,
    "count": 2
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 30000, "message": "Authentication failed" }
              
              {
    "code": 30000,
    "message": "Authentication failed"
}
Afficher ce bloc de code dans la fenêtre flottante

Mettre à jour une étiquette de campagne

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

PUT
              
              PUT
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Paramètres de chemin (Path Parameters)

Parameter Type Required Description
tag_id string true ID de l'étiquette

Paramètres du corps (Body Parameters)

Parameter Type Required Description
tag_name string true Nom de l'étiquette. Seuls les caractères chinois, les lettres anglaises majuscules et minuscules, les chiffres et les underscores sont pris en charge. Longueur : 1 à 64 caractères.

Exemple de requête (Request Example)

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{ "tag_name": "promotion_soldes" }'
              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic  YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/64a1f2e0c9e1a23456789012) --data '{
    "tag_name": "promotion_soldes"
}'
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "count": 1 }
              
              {
    "count": 1
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Afficher ce bloc de code dans la fenêtre flottante

Supprimer une étiquette de campagne

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags](https://email.api.engagelab.cc/v1/marketing/campaigns/tags)
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

DELETE
              
              DELETE
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/x-www-form-urlencoded;charset=utf-8
              
              application/x-www-form-urlencoded;charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Remarques :

  1. Après la suppression d'une étiquette, celle-ci sera automatiquement retirée des campagnes associées.

Exemple de requête (Request Example)

curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)
              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f)
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "count": 2 }
              
              {
    "count": 2
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 32606, "message": "tag_id cannot be empty" }
              
              {
    "code": 32606,
    "message": "tag_id cannot be empty"
}
Afficher ce bloc de code dans la fenêtre flottante

Ajouter des étiquettes aux campagnes

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/add
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

POST
              
              POST
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Paramètres du corps (Body Parameters)

Parameter Type Required Description
campaign_ids array[string] * Liste des ID de campagne. Jusqu'à 200 ID par requête.

Remarques :

  1. Chaque campagne peut comporter un maximum de 20 étiquettes.

Exemple de requête (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{ "campaign_ids": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/61c2be010d2b4e6a3836ab1f/add) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Afficher ce bloc de code dans la fenêtre flottante

Retirer des étiquettes des campagnes

URL

[https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
              
              [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/){tag_id}/remove
Afficher ce bloc de code dans la fenêtre flottante

Méthode HTTP

POST
              
              POST
Afficher ce bloc de code dans la fenêtre flottante

Content-Type

application/json; charset=utf-8
              
              application/json; charset=utf-8
Afficher ce bloc de code dans la fenêtre flottante

En-têtes de requête (Request Headers)

Header Type Required Description
Authorization string true Basic base64(api_user:api_key)

Paramètres du corps (Body Parameters)

Parameter Type Required Description
campaign_ids array[string] * Liste des ID de campagne. Jusqu'à 200 ID par requête.

Exemple de requête (Request Example)

curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{ "campaign_ids": [ "61c2be010d2b4e6a3836ab1f", "61c2be010d2b4e6a3836ab1d" ] }'
              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i [https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove](https://email.api.engagelab.cc/v1/marketing/campaigns/tags/616683a13a7b531b0336108d/remove) --data '{
  "campaign_ids": [
    "61c2be010d2b4e6a3836ab1f",
    "61c2be010d2b4e6a3836ab1d"
  ]
}'
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse (Response Example)

Response-Success

HttpStatus: 200

{ "total": 3 }
              
              {
    "total": 3
}
Afficher ce bloc de code dans la fenêtre flottante

Response-Error

HttpStatus: 401

{ "code": 32605, "message": "Campaign tag not found" }
              
              {
    "code": 32605,
    "message": "Campaign tag not found"
}
Afficher ce bloc de code dans la fenêtre flottante
Icon Solid Transparent White Qiyu
Contactez-nous