member_fields

Adresse d'appel

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, assurez-vous que le centre de données sélectionné correspond à l'URL de base appropriée.

POST/v1/marketing/lists/fields

Créer

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields

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 la requête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
field_name	string	oui	Nom du champ (64 caractères maximum, composé uniquement de a-z, A-Z, 0-9, _ et ne peut pas être un champ système ; y compris les champs système Email, Name, Phone, un total de 50 champs peuvent être créés)
field_type	integer	oui	Type de champ (0 : texte, 1 : nombre, 2 : date, 3 : anniversaire, 4 : liste déroulante)
visible	boolean	oui	Champ visible ou non, true ou false
format	string	non	Format des données : 0 ou .0 ou .00 (lorsque field_type=1) ; MM/JJ/AAAA ou JJ/MM/AAAA (lorsque field_type=2) ; MM/JJ ou JJ/MM (lorsque field_type=3)
options	string[]	non	Liste des éléments pour le type liste déroulante, ne peut pas être vide lorsque field_type est liste déroulante, maximum 10 éléments

Remarque :

Champs système : Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime.
Les noms de champs ne peuvent pas être des champs système, et la modification de la casse n'est pas autorisée pour leur création.

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/fields --data '{ "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" }'

              
              curl -X POST -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields --data '{
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
}'

Afficher ce bloc de code dans la fenêtre flottante

Réponse-Succès

HttpStatus : 200

{ "result": { "field_id": 11, "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" } }

              
              { 
 "result": {
   "field_id": 11,
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
  }
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-Erreur

HTTP Status :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/fields/{field_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_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 la requête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	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/fields/569

              
              curl -X DELETE -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/569

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": 30037, "message": "Échec de la suppression" }

              
              {
  "code": 30037,
  "message": "Échec de la suppression"
}

Afficher ce bloc de code dans la fenêtre flottante

Mettre à jour

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_id}

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields/{field_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 la requête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Paramètres du corps de la requête

Paramètre	Type	Obligatoire	Description
field_name	string	oui	Nom du champ (64 caractères maximum, composé uniquement de a-z, A-Z, 0-9, _, et ne peut pas être un champ système (insensible à la casse) ; un total de 50 champs peuvent être créés, y compris les champs système Email, Name, Phone)
field_type	integer	oui	Type de champ (0 : texte, 1 : nombre, 2 : date, 3 : anniversaire, 4 : liste déroulante)
visible	boolean	oui	Champ visible ou non, true ou false
format	string	non	Format des données : 0 ou .0 ou .00 (field_type=1) ; MM/JJ/AAAA ou JJ/MM/AAAA (field_type=2) ; MM/JJ ou JJ/MM (field_type=3)
options	string[]	non	Contenu de la liste déroulante pour le type liste déroulante ; ne doit pas être vide lorsque field_type est liste déroulante, maximum 10 éléments.

Remarque :

Champs système : Email, Name, Phone, Tag, Campaign, Segment, Domain, CreateTime, UpdateTime, UnsubscribeTime

Exemple de requête

curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{ "field_name": "xiao", "field_type": 3, "visible": true, "format": "MM/DD" }'

              
              curl -X PUT -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields/839 --data '{
  "field_name": "xiao",
  "field_type": 3,
  "visible": true,
  "format": "MM/DD"
}'

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": "Introuvable" }

              
              {
    "code": 30036,
    "message": "Introuvable"
}

Afficher ce bloc de code dans la fenêtre flottante

Liste des champs

URL

https://email.api.engagelab.cc/v1/marketing/lists/fields

              
              https://email.api.engagelab.cc/v1/marketing/lists/fields

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 la requête

En-tête	Type	Obligatoire	Description
Authorization	string	oui	Basic base64(api_user:api_key)

Paramètres de la requête

Paramètre	Type	Obligatoire	Description
field_name	string	non	Nom du champ, requête floue

Exemple de requête

curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age

              
              curl -X GET -H 'Authorization:Basic YXBpX3VzZXI6YXBpX2tleQ==' -i https://email.api.engagelab.cc/v1/marketing/lists/fields?field_name=Age

Afficher ce bloc de code dans la fenêtre flottante

Paramètres de réponse

Paramètre	Type	Description
result	array[object]	Liste des champs
field_name	string	Nom du champ (jusqu'à 64 caractères, composé uniquement de a-z, A-Z, 0-9, _, et ne peut pas être un champ système (insensible à la casse) ; un total de 50 champs peuvent être créés, y compris les champs système Email, Name, Phone)
field_type	integer	Type de champ (0 : texte, 1 : nombre, 2 : date, 3 : anniversaire, 4 : liste déroulante)
visible	boolean	Visibilité (true ou false)
format	string	Format des données : 0 ou .0 ou .00 (field_type=1) ; MM/JJ/AAAA ou JJ/MM/AAAA (field_type=2) ; MM/JJ ou JJ/MM (field_type=3)
options	string[]	Contenu de la liste déroulante pour le type liste déroulante, ne doit pas être vide lorsque field_type est liste déroulante, maximum 10 éléments
field_id	integer	Index correspondant au champ, -1 indique un champ système
total	integer	Nombre total d'enregistrements correspondant à la requête
count	integer	Nombre d'enregistrements correspondant à la requête dans ce résultat

Exemple de réponse

Réponse-Succès

HttpStatus : 200

{ "result": [ { "field_name": "Email", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Name", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Phone", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": -1 }, { "field_name": "Gender", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": 0 }, { "field_name": "Birthday", "field_type": 3, "visible": true, "format": "MM/DD", "options": null, "field_id": 1 }, { "field_name": "Age", "field_type": 1, "visible": true, "format": "0", "options": null, "field_id": 2 }, { "field_name": "remark", "field_type": 0, "visible": true, "format": null, "options": null, "field_id": 3 } ], "total": 7, "count": 7 }

              
              {
  "result": [
    {
      "field_name": "Email",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Name",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Phone",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": -1
    },
    {
      "field_name": "Gender",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": 0
    },
    {
      "field_name": "Birthday",
      "field_type": 3,
      "visible": true,
      "format": "MM/DD",
      "options": null,
      "field_id": 1
    },
    {
      "field_name": "Age",
      "field_type": 1,
      "visible": true,
      "format": "0",
      "options": null,
      "field_id": 2
    },
    {
      "field_name": "remark",
      "field_type": 0,
      "visible": true,
      "format": null,
      "options": null,
      "field_id": 3
    }
  ],
  "total": 7,
  "count": 7
}

Afficher ce bloc de code dans la fenêtre flottante

Réponse-Erreur

HTTP Status :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

Champs_Membre

Adresse d'appel

Créer

Supprimer

Mettre à jour

Liste des champs