List.AddSegment

URL https://api.dpmail.fr/json/List.AddSegment.php

Ajouter un segment sur une liste.

Paramètres et infos requises

ListID - String
L'identifiant de la liste

Name - String
Le nom du segment

Conditions - JsonString
Un tableau de conditions de sélection des contacts

Les conditions sont représentées en JSON, regroupées dans un tableau, chaque condition est un objet qui suit le schéma de l'exemple suivant :

[
  {
    "field" : "email",
    "op" : "ends",
    "value" : "@orange.fr"
  }, {
    "field" : "code_postal",
    "op" : "starts",
    "value" : "81"
  }, {
    "field" : "subscribe",
    "op" : "less",
    "value" : "2015-08-31"
  }
]

Les opérateurs applicables diffèrent en fonction du type de champ:

• type STRING: equal (est égal),
  not equal (n'est pas égal),
  blank (est vide),
  not blank (n'est pas vide),
  contains (contient, like '%XXX%'),
  not contains (ne contient pas),
  starts (commence par, like 'XXX%'),
  ends (se termine par, like '%XXXX')
• types NUMBER et DATE: equal (est égal),
  not equal (n'est pas égal),
  greater (NUMBER est plus grand, DATE est après),
  less (NUMBER est plus petit, DATE est avant),
  not blank (n'est pas vide),
  blank (est vide)

Codes de retour

Succès

0: Success
Le SegmentID utilisable avec les autres fonctions de l'API

Erreur

11: JSON invalide
La chaîne JSON passée en paramètre est invalide.

301: ListID invalide
L'identifiant de liste fourni est invalide.

310: Nom invalide
Le nom que vous avez choisi pour votre segment est invalide.

311: Aucune condition trouvée
Le paramètre Conditions est vide ou n'est pas un tableau.

312: Paramètre field invalide
Une des conditions mentionne une valeur incorrecte pour le field.

313: Opérateur invalide
L'opérateur choisi n'est pas valide pour le champ mentionné dans la condition.

314: Valeur invalide
Le value de la condition n'est pas correct, par exemple le format de la date ne respecte pas YYYY-MM-DD, ou une chaine est passée pour un champ de type NUMBER.

315: Condition malformée
Chaque condition doit contenir les 3 propriétés field, op, value.