POST api/jobs HTTP/1.1
Authorization: <apikey>
Content-Type: application/json
Content-Lenght: <taille en octet des données JSON ci-dessous>
 

{
"job" : {
    "ref"         :  <référence du job (3-30 chars ‘a’-‘z’ ‘0’-‘9’ ‘-‘>,
    "title"       :  <intitule du job>,
    "tags"        :  [ <liste de mots clefs de recherches>,… ],
    "datestart"   :  <date de début des envois, au format YYMMDDhhmmss>,
    "datestop"    :  <date de fin des envois, au format YYMMDDhhmmss>,
    "retrynb"     :  <nombre de ré-essais>,
    "retrydelay"  :  <délai entre les ré-essais>
    }, 
 

 "header" : { 
    "subject"     :  <sujet de l’email>,
    "from"        :  { "addr": <email de l’expéditeur> , "name": <nom de
                       l’expéditeur > },
    "sender"      :  { "addr": <email du sender > , "name": <nom du sender> },
    "reply-to"    :  { "addr": <email de réponse> , "name": <nom de réponse> },
    "to"          :  [ { "addr" : <email du destinataire>, "name" : <nom du
                       destinataire> },… ],
    "cc"          :  [ { "addr" : <email du destinataire>, "name" : <nom du
                       destinataire> },… ],
    "feedback-id" :  <champ feedback-id (Google) au format_a:b:c:d>,
    "precedence"  :  <champ precedence (Google) true/false>,
    "unlst"       :  <champ List-Unsubscribe : liens http/smtp/both>,
    "charset"     :  <charset d’encodage du header des emails, def utf-8>
    },
 

 "recipients" : {
    "path"        : <@path de la liste des destinataires au format csv OU nom de la section                         contenant l'enregistrement du destinataire, par exemple "rec", voir ci-                         dessous>,
    "charset"     : <charset d’encodage de la liste>,
    "testaddr"    : [<liste d’emails de test >,… ],
    "checkaddr"   : [<liste d’emails pour envoi depuis chaque IP >,… ],
    "filter"      : [<liste de blacklistes utilisées pour le filtrage>,… ],
    "optout"      : <nom de la liste dans laquelle enregistrer les unsubs>

    },
 

 "rec" : {

    "email"        : <adresse email du destinataire - champ obligatoire>,

    "custom1"      : <premier champ custom du destinataire, par exemple "name" : "xxx">,

    "custom2"      : <second champ custom du destinataire>,

         ...

    "custom(n)"    : <dernier champ custom du destinataire>

    },

​

 "txtbody" : {
    "path"        : <@path du fichier body txt>,
    "encoding"    : <format d’encodage du body, def Quoted-Printable>,
    "charset"     : <charset du fichier body txt>
    },
 

 "htmbody" : {
    "path"        : <@path du fichier body htm>,
    "encoding"    : <format d’encodage du body, def Quoted-Printable>,
    "charset"     : <charset du fichier body htm>
    },
 

 "attachments" : [ {
    "path"        : <@path du fichier de la pièce jointe>,
    "encoding"    : <format d’encodage de la pièce jointe, def Base64>,
    },… ],
 

 "images" : [ {
    "path"        : <@path du fichier de l’image encapsulée>,
    "encoding"    : <format d’encodage de l’image, def Base64>,
    },… ],

 "tracking" : {
    "host"        : <nom de domaine utilisé pour les URL trackées>,

    "open"        : <option de tracking d’ouverture : disable/image/pixel>,
    "click"       : <option de tracking de clics : disable/short/embedded>,
    "image"       : <option de tracking d’images : disable/short/embedded>,
    "bot"         : <option d’insertion de lien masqué : enable/disable>,
    "unsub"       : <lien vers la page de désabonnement>,
    "uncfm"       : <lien vers la page de confirmation de désabonnement>,
    "mirror"      : <lien vers la page miroir>,
    "https"       : <option de liens de tracking en https : true/false>

    },

 

 "routing" : {

    "ehlo"        : <nom de domaine utilisé dans le EHLO (@rdns)>,

    "envelopefrom": <adresse utilisée dans l’email de MAIL FROM : @mailfrom/@verp/@from>,

    "sign"        : <flag de signature DKIM : from/envelope/both>,

    "starttls"    : <flag d’utilisation de STARTTLS : true/false>,

    "ip"          : <liste d'IPs et/ou ressources d’émission>

    }
}

​

-----------------------------------------------------------------------------------------------HTTP/1.1 200 OK
Content-Type: application/json
Content-Lenght: <taille en octet des données JSON ci-dessous>

{
"stamp" : {
    "date"        : <date de prise en compte YYMMDDhhmmss>,
    "mailno"      : <reference système sous laquelle est enregistrée le job>,
    "err"         : <code d’erreur, 0=OK>,
    "msg"         : <description du code d’erreur>
    }
}