Besoin d'aide ?

API : Méthodes sur les listes

 

Methode : get_list

 

Cette méthode sert à récupérer les informations de vos listes suivant vos paramètres, ou une liste en particulier suivant son identifiant.

 

Champ Type Description
listeid integer Identifiant de votre liste
Si ce paramètre est définit, vos autres paramètres ne seront pas pris en compte(Optionnel)
nom string Nom de votre liste(Optionnel)
langue string Langue de votre liste
'francais', 'anglais', 'espagnol', 'portugais', 'allemand', 'russe', 'esperanto', 'neerlandais'(Optionnel)
siteweb string Site web de redirection votre liste(Optionnel)
email_exp integer Adresse email d'expedition de votre liste(Optionnel)
rep_mail integer Adresse email de reception de votre liste(Optionnel)
optin integer Optin de votre liste
1 : Simple
2 : Double(Optionnel)
parent integer Liste parent de votre liste(Optionnel)
limite array Limite de récupération de données.
Format [0,50](Optionnel)
                                        
                                           
// Recherche de listes enfant de la liste 12345 $sgApi ->set('parent', 12345) ->set('detail' true); $call = $sgApi->call('get_list');

 

Methode : set_liste

 

Cette méthode sert à créer une liste suivant vos paramètres

 

Champ Type Description
nom string Nom de votre liste
Paramètre requis
email_exp string Adresse email de l'expediteur
Paramètre requis
nom_exp string Nom de l'expediteur
Paramètre requis
email_rep string Adresse email de reception de votre listeParamètre requis
signature string Signature de votre liste(Optionnel)
optin integer Optin de votre liste
1 : Simple
2 : DoubleParamètre requis
langue string Langue de votre liste
'francais', 'anglais', 'espagnol', 'portugais', 'allemand', 'russe', 'esperanto', 'neerlandais'(Optionnel)
parent integer Liste parent de votre liste(Optionnel)
insc_subject string Sujet d'inscription de votre liste(Optionnel)
insc_mail string Message d'inscription de votre liste(Optionnel)
insc_link string Lien de redirection après inscription(Optionnel)
conf_subject string Sujet de confirmation de votre liste(Optionnel)
conf_mail string Message de confirmation de votre liste(Optionnel)
conf_link string Lien de redirection après confirmation(Optionnel)
                                        
                                           
// Ajout d'une liste. $sgApi ->set('nom', "Liste Test API") ->set('email_exp', "John.Doe@mail.ext") ->set('nom_exp', "John Doe") ->set('optin', 1) ->set('langue', "francais"); $call = $sgApi->call('set_list'); 

 

Methode : del_liste

 

Cette méthode sert à supprimer une listes suivant son identifiant.

Attention ! La suppression d'une liste entraine la suppression des :
  • Contacts dans cette liste,
  • Emails dans cette liste,
  • Emails brouillons dans cette liste,
  • Formulaires dans cette liste,
  • Règles de cette liste (Segmentation, répartition, parrainage, sommeil).
Champ Type Description
listeid integer Identifiant de votre liste
                                        
                                           
// Suppression de la liste 12345 $sgApi ->set('listeid', 12345); $call = $sgApi->call('del_list'); 

Questions relatives