Tags
Adresse d'appel
| Centre de données | URL |
|---|---|
| Singapour | https://email.api.engagelab.cc |
| Turquie | https://emailapi-tr.engagelab.com |
Lorsque vous utilisez l'API REST, assurez-vous que le centre de données sélectionné correspond à la base URL appropriée.
POST/v1/marketing/lists/tags
Créer
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags
https://email.api.engagelab.cc/v1/marketing/lists/tags
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Paramètres du corps de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| tag_name | string | true | Nom du tag, jusqu'à 64 caractères, composé uniquement de a-z, A-Z, 0-9, _, caractères chinois, etc. |
Exemple de requête
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
"name": "myCustomTag"
}'
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags --data '{
"name": "myCustomTag"
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-Succès
HttpStatus:200
{
"result":{
"tag_id": "62732d3ddd017d22ccd118e4",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time": "2023-11-28T11:14:48+0800"
}
}
{
"result":{
"tag_id": "62732d3ddd017d22ccd118e4",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time": "2023-11-28T11:14:48+0800"
}
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
HttpStatus: 401
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
Supprimer
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Exemple de requête
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f
curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-Succès
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
{
"code": 30036,
"message": "Ressource non trouvée"
}
{
"code": 30036,
"message": "Ressource non trouvée"
}
Afficher ce bloc de code dans la fenêtre flottante
Mettre à jour
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Paramètres du corps de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| tag_name | string | false | Nom du tag, jusqu'à 64 caractères, composé uniquement de a-z, A-Z, 0-9, _, caractères chinois, etc. |
Exemple de requête
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
"name": "myCustomTag"
}'
curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://api2.sendcloud.net/marketing/lists/tags/617a71ac672b2823a1a82c13 61c2be010d2b4e6a3836ab1f --data '{
"name": "myCustomTag"
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-Succès
HttpStatus: 200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
HttpStatus: 400
{
"code": 30035,
"message": "Le nom du tag ne doit contenir que des caractères a-z, A-Z, 0-9, _, caractères chinois, jusqu'à 64 caractères"
}
{
"code": 30035,
"message": "Le nom du tag ne doit contenir que des caractères a-z, A-Z, 0-9, _, caractères chinois, jusqu'à 64 caractères"
}
Afficher ce bloc de code dans la fenêtre flottante
Liste des tags
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags
https://email.api.engagelab.cc/v1/marketing/lists/tags
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Paramètres de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| tag_name | string | false | Nom du tag à rechercher (prise en charge de la recherche floue) |
| offset | integer | false | Position de départ de la requête, plage de valeurs [0-], par défaut 0 |
| limit | integer | false | Nombre de résultats, plage de valeurs [1-100], par défaut 10 |
Exemple de requête
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags?offset=0&limit=10&name=education
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de réponse
| Paramètres | Type | Description |
|---|---|---|
| result | array[object] | Liste des tags |
| tag_id | string | ID du tag |
| tag_name | string | Nom du tag |
| create_time | string | Date de création |
| update_time | string | Date de mise à jour |
| count | integer | Nombre de membres avec ce tag |
| total | integer | Nombre total d'enregistrements |
| count | integer | Nombre d'enregistrements retournés |
Exemple de réponse
Réponse-Succès
HttpStatus: 200
{
"result": [
{
"tag_id": "617a71ac672b2823a1a82c13",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time":"2023-11-28T11:14:48+0800",
"count": 1
}
],
"count": 1,
"total": 1
}
{
"result": [
{
"tag_id": "617a71ac672b2823a1a82c13",
"tag_name": "education",
"create_time": "2023-11-28T11:14:48+0800",
"update_time":"2023-11-28T11:14:48+0800",
"count": 1
}
],
"count": 1,
"total": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
HttpStatus: 401
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
Ajouter des tags à un membre
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/add
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Basic base64(api_user:api_key) |
Paramètres du corps de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| member_ids | string[] | true | Liste des IDs de membres, maximum 1000 à la fois |
Exemple de requête
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/61c2be010d2b4e6a3836ab1f/add --data '{
"member_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/lists/tags/61c2be010d2b4e6a3836ab1f/add --data '{
"member_ids": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-Succès
HttpStatus: 200
{
"count": 2
}
{
"count": 2
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
HttpStatus: 401
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
Retirer des tags d'un membre
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/remove
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Bearer Token |
Paramètres du corps de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| member_ids | array[string] | true | Liste des IDs de membres, maximum 1000 à la fois |
Exemple de requête
curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Bearer YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/remove --data '{
"memberIds": [
"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/lists/tags/616683a13a7b531b0336108d/remove --data '{
"memberIds": [
"61c2be010d2b4e6a3836ab1f",
"61c2be010d2b4e6a3836ab1d"
]
}'
Afficher ce bloc de code dans la fenêtre flottante
Exemple de réponse
Réponse-Succès
HttpStatus:200
{
"count": 1
}
{
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
HttpStatus: 401
Réponse-Erreur
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
Obtenir les membres
URL
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members
https://email.api.engagelab.cc/v1/marketing/lists/tags/{tag_id}/members
Afficher ce bloc de code dans la fenêtre flottante
Méthode de requête 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
| En-tête | Type | Obligatoire | Description |
|---|---|---|---|
| Authorization | string | true | Bearer Token |
Paramètres de requête
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| offset | integer | false | Position de départ de la requête, plage de valeurs [0-], par défaut 0 |
| limit | integer | false | Nombre de résultats, plage de valeurs [1-100], par défaut 10 |
Exemple de requête
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10
curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/tags/616683a13a7b531b0336108d/members?offset=0&limit=10
Afficher ce bloc de code dans la fenêtre flottante
Paramètres de réponse
| paramètres | Type | Description |
|---|---|---|
| result | object | Liste des membres |
| member_id | string | ID du membre |
| list_id | integer | ID de la liste |
| string | Adresse e-mail | |
| phone | string | Numéro de téléphone |
| name | string | Nom |
| create_time | string | Date de création (UTC+8) |
| update_time | string | Date de mise à jour (UTC+8) |
| unsubscribe_time | string | Date de désabonnement (UTC+8) |
| fields | object | Champs du membre |
| tag_ids | array[string] | Ensemble d'IDs de tags |
| tag_names | array[string] | Ensemble de noms de tags |
| total | integer | Nombre total d'enregistrements correspondant à la requête |
Exemple de réponse
Réponse-Succès
HttpStatus: 200
{
"result": [
{
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [
"646f28a7cac6587565ad6918"
],
"tag_names": [
"test"
],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:42:11+0800",
"unsubscribe_time": null
}
],
"total": 2,
"count": 1
}
{
"result": [
{
"member_id": "6565c12a3b4e0d83d3f58ea0",
"list_id": 95964,
"email": "xjmfc@126.com",
"phone": null,
"name": null,
"fields": {
"Birthday": "03/30",
"Age": "12"
},
"tag_ids": [
"646f28a7cac6587565ad6918"
],
"tag_names": [
"test"
],
"create_time": "2023-11-28T18:30:02+0800",
"update_time": "2023-11-30T16:42:11+0800",
"unsubscribe_time": null
}
],
"total": 2,
"count": 1
}
Afficher ce bloc de code dans la fenêtre flottante
Réponse-Erreur
HttpStatus: 401
{
"code": 30000,
"message": "Échec de l'authentification"
}
{
"code": 30000,
"message": "Échec de l'authentification"
}
Afficher ce bloc de code dans la fenêtre flottante
