NAV Navbar
curl
  • Introduction
  • Authentification
  • Listes de contacts
  • Listes noires
  • Campagnes
  • Statistiques
  • Webhooks
  • Introduction

    Bienvenue sur la documentation dédiée aux API de Sarbacane. Vous retrouverez ici toute l'aide nécéssaire à leur intégration.

    Ces API sont de type REST/JSON.

    L'ensemble de nos endpoints (url d'accès) s'utilise dans la méthode HTTP adéquate, mais propose également un doublon en GET via une seule URL qui embarque le nécessaire (authentification & paramètres).

    Cette fonctionnalité permet notamment d'implémenter nos API sans avoir à développer de connecteur.

    Authentification

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/info"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/info"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    L'authentification est basée sur un couple de paramètres: l'id de votre compte, ainsi que votre clé API.

    Paramètres d’authentification:

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API

    Ces paramètres peuvent être utilisés dans deux méthodes d'authentification distinctes:

    Listes de contacts

    Lister les listes

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists?offset=0&limit=3"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists?offset=0&limit=3"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

     [
        {
            "count": 200000,
            "created": "2017-08-24T14:59:36Z",
            "customFields": null,
            "edited": "2017-08-24T15:00:56Z",
            "id": "z2P3eXaMQUq9-kIL3wV1Cg",
            "kind": "NORMAL",
            "name": "Exemple: 200 000"
        },
        {
            "count": 1,
            "created": "2017-08-30T10:24:50Z",
            "customFields": null,
            "edited": "2017-08-30T10:26:14Z",
            "id": "eTO6OsIaSPeeOdAYqBiL8A",
            "kind": "NORMAL",
            "name": "Exemple: api list"
        },
        {
            "count": 5,
            "created": "2017-09-28T08:06:22Z",
            "customFields": null,
            "edited": "2017-09-28T08:06:27Z",
            "id": "vaJ_WhfRSsKNjw3DvqRy8w",
            "kind": "NORMAL",
            "name": "Exemple: test"
        },
    ]
    

    Permet de récupérer toutes les listes de contacts disponibles.

    HTTP Request

    GET https://sarbacaneapis.com/v1/lists

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    offset 0 Position du curseur [0-9]*
    limit max Nombre de listes [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter une liste

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"name": "API List"}'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"name": "API List"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "count": 0,
        "created": "2017-10-02T08:26:10Z",
        "customFields": null,
        "edited": "2017-10-02T08:26:10Z",
        "id": "AhjmGK9YRlGbXKawl1pBvw",
        "kind": "NORMAL",
        "name": "API List"
    }
    

    Permet de créer une liste de contacts.

    HTTP Request

    POST https://sarbacaneapis.com/v1/lists

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    name null Nom de la liste
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier une liste

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"name": "New list name"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"name": "New list name"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "created": "2017-10-02T08:26:10Z",
        "id": "AhjmGK9YRlGbXKawl1pBvw",
        "kind": "NORMAL",
        "modified": "2017-10-02T08:26:10Z",
        "name": "New list name"
    }
    

    Permet de modifier une liste de contacts.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/lists/{listId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    name null Nouveau nom de la liste
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer une liste

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    
    

    Permet de supprimer une liste de contacts.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/lists/{listId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les champs personnalisés

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "fields": [
            {
                "caption": "Creation Date",
                "id": "CREATION_DATE_ID",
                "kind": ""
            },
            {
                "caption": "Modification Date",
                "id": "MODIFICATION_DATE_ID",
                "kind": ""
            },
            {
                "caption": "email",
                "id": "EMAIL_ID",
                "kind": ""
            },
            {
                "caption": "phone",
                "id": "PHONE_ID",
                "kind": ""
            },
            {
                "caption": "Nom",
                "id": "AIUxng6TSyy1VRSWChPMnA",
                "kind": "STRING"
            },
            {
                "caption": "Inscrit",
                "id": "Be3o05ylR1Obz83GZc1Dkw",
                "kind": "BOOL"
            },
            {
                "caption": "Age",
                "id": "CyWAmoViRGyj_vtxMgg-qA",
                "kind": "INT"
            },
            {
                "caption": "Anniversaire",
                "id": "DbwHHDIiSEWER5KUyrIJVQ",
                "kind": "DATE"
            },
            {
                "caption": "ADDRESS",
                "id": "Ei_23RzYRF2MOzz_h__eLA",
                "kind": "STRING"
            }
        ]
    }
    

    Permet de récupérer les champs personnalisés (colonnes) d'une liste.

    HTTP Request

    GET https://sarbacaneapis.com/v1/lists/{listId}/fields

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un champ

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{ "kind": "STRING", "caption": "ADDRESS" }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{ "kind": "STRING", "caption": "ADDRESS" }'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "caption": "ADDRESS",
        "id": "Ei_23RzYRF2MOzz_h__eLA",
        "kind": "STRING"
    }
    

    Permet d'ajouter un champ (une colonne) à une liste.

    HTTP Request

    POST https://sarbacaneapis.com/v1/lists/{listId}/fields

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    kind null STRING, BOOL, INT ou DATE
    caption null Nom de référence de la colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier un champ

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{ "kind": "STRING", "caption": "New name"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{ "kind": "STRING", "caption": "New name"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "caption": "New name",
        "id": "RIUxng6TSyy1VRSWChPMnA",
        "kind": "STRING"
    }
    

    Permet de modifier un champ.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    kind null STRING, BOOL, INT or DATE
    caption null Nom de référence de la colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer un champ

    HTTP Authentication

    curl -X  DELETE "https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Headers Authentication

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body :

    
    

    Permet de supprimer un champ (colonne) d'une liste.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/lists/{listId}/fields/{fieldId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer tous les champs

    HTTP Authentication

    curl -X  DELETE "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Headers Authentication

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/fields"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body :

    
    

    Permet de supprimer l'ensemble des champs (colonnes) d'une liste.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/lists/{listId}/fields

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les contacts

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists/{listId}/contacts?offset=0&limit=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/lists/{listId}/contacts?offset=0&limit=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    [
        {
            "created": "2018-05-25T09:12:29Z",
            "edited": "2018-05-25T09:12:29Z",
            "email": "user1@sarbacane.com",
            "ialonrh54rrpmjvj1ywn": "3 rue des lilas 59000 LILLE",
            "id": "jfjC1uwfRKCLWOkAYkzSrA",
            "phone": "+33600000001"
        },
        {
            "created": "2018-05-25T09:09:50Z",
            "edited": "2018-05-25T09:09:50Z",
            "email": "user2@sarbacane.com",
            "ialonrh54rrpmjvj1ywn": "51 rue de la gare 92000 PARIS",
            "id": "CYeg4jdgSKqXwmGaXQwjrA",
            "phone": "+33600000002"
        }
    ]
    

    Permet de lister les contacts d'une liste.

    HTTP Request

    GET https://sarbacaneapis.com/v1/lists/{listId}/contacts

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    offset 0 Position du curseur [0-9]*
    limit 1 Nombre de contacts [0-9]* - Max:1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un contact

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/contacts"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{   "email": "user3@sarbacane.com", \
            "phone": "+33600000003", \
            "nvVhK7dwSJyPAbFKrfUtjw": "18 rue de la plage 33000 BORDEAUX" }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/contacts"
    -H "accountId: YOUR_ACCOUNTID"
    -H "apiKey: YOUR_API_KEY"
    -d '{   "email": "user3@sarbacane.com", \
        "phone": "+33600000003", \
        "nvVhK7dwSJyPAbFKrfUtjw": "18 rue de la plage 33000 BORDEAUX" }'
    
    

    Response code:

    HTTP/2 200
    

    Response body:

    [
        "Mru3FE5fQnepxDgvuz3M9A",
        "2018-05-25T09:50:15Z",
        "2018-05-25T09:50:15Z",
        "user3@sarbacane.com",
        "+33600000003",
        "18 rue de la plage 33000 BORDEAUX"
    ]
    

    Permet d'ajouter un contact à une liste.

    HTTP Request

    POST https://sarbacaneapis.com/v1/lists/{listId}/contacts

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    email null L'e-mail du contact
    phone null Le numéro de mobile du contact
    fieldId null id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier un contact

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/contacts/{contactId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "newEmail@sarbacane.com", "phone": "+33670000001", "ialonrh54rrpmjvj1ywn": "Nouvelle adresse"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/contacts/{contactId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "newEmail@sarbacane.com", "phone": "+33670000001", "ialonrh54rrpmjvj1ywn": "Nouvelle adresse"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    
    

    Permet de modifier un contact dans une liste.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/lists/{listId}/contacts

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    contactId null Id du contact à modifier
    email null Le nouvel e-mail du contact
    phone null Le nouveau numéro de mobile du contact
    fieldId null Id d'une colonne à modifier
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un bloc de contacts (JSON)

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/contacts/import"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '[{"email": "user1@domain.com", "phone": "+33600000001" }, \
            {"email": "user2@domain.com", "phone": "+33600000002"}, \
            {"email": "user3@domain.com", "phone": "+33600000003"} ]'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/contacts/import"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '[{"email": "user1@domain.com", "phone": "+33600000001" }, \
        {"email": "user2@domain.com", "phone": "+33600000002"}, \
        {"email": "user3@domain.com", "phone": "+33600000003"} ]'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "invalid": 0,
        "valid": 3
    }
    

    Permet d'ajouter un bloc (JSON) de contacts.

    HTTP Request

    POST https://sarbacaneapis.com/v1/lists/{listId}/contacts/import

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste concernée
    email E-mail Nom de la colonne E-mail
    phone Mobile Nom de la colonne Mobile
    fieldId null id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer un contact

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts/Mru3FE5fQnepxDgvuz3M9A"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    
    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts?email=user1@domain.com"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts/Mru3FE5fQnepxDgvuz3M9A"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    
    curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts?email=user1@domain.com"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer un contact dans une liste.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/lists/{listId}/contacts/{contactId}

    DELETE https://sarbacaneapis.com/v1/lists/{listId}/contacts

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste
    contactId null Id du contact
    email null E-mail du contact
    phone null Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer tous les contacts

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/empty"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/empty"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer l'ensemble des contacts d'une liste.

    HTTP Request

    POST https://sarbacaneapis.com/v1/lists/{listId}/empty

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    listId null Id de la liste
    email null E-mail du contact
    phone null Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Listes noires

    Lister les listes noires

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists?offset=0&limit=3"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists?offset=0&limit=3"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "blacklists": [
            {
                "count": 179,
                "creationDate": "2017-08-22T15:39:56Z",
                "id": "DEFAULT_BOUNCELIST",
                "modificationDate": "2017-08-22T15:40:24Z",
                "name": ""
            },
            {
                "count": 55,
                "creationDate": "2017-08-22T14:49:36Z",
                "id": "DEFAULT_BLACKLIST",
                "modificationDate": "2017-08-22T15:40:50Z",
                "name": ""
            },
            {
                "count": 154,
                "creationDate": "2017-09-14T12:47:43Z",
                "id": "yfownwJES8K2Y_RPWvOnfw",
                "modificationDate": "2017-09-14T12:47:43Z",
                "name": "Liste d\u00e9sabo Client1"
            }
        ]
    }
    
    

    Permet de récupérer toutes les listes noires disponibles.

    HTTP Request

    GET https://sarbacaneapis.com/v1/blacklists

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    offset 0 Position du curseur [0-9]*
    limit max Nombre de listes [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter une liste noire

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"name": "Nom de la liste"}'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"name": "Nom de la liste"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "blacklist": {
            "created": "2017-09-14T12:51:14Z",
            "creator": "API",
            "id": "rqWxwoUMRqKJDkyfUG8UAA",
            "kind": "BLACKLIST",
            "modified": "2017-09-14T12:51:14Z",
            "modifier": "API",
            "name": "Exemple"
        }
    }
    

    Permet de créer une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    name null Nom de la liste noire
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier une liste noire

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"name": "Nouveau nom de la liste"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{bkacklistId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"name": "Nouveau nom de la liste"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "created": "2017-09-14T12:51:14Z",
        "id": "rqWxwoUMRqKJDkyfUG8UAA",
        "kind": "BLACKLIST",
        "modified": "2017-09-14T18:24:12Z",
        "name": "Nouveau nom de la liste"
    }
    

    Permet de modifier une liste noire.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/blacklists/{blacklistId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    name null Nom de la liste noire
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer une liste noire

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer une liste noire.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/blacklists/{blacklistId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les champs personnalisés des listes noires

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/fields"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/fields"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "fields": [
            {
                "caption": "EMAIL",
                "id": "EMAIL_ID",
                "kind": ""
            },
            {
                "caption": "PHONE",
                "id": "PHONE_ID",
                "kind": ""
            }
        ]
    }
    

    Permet de récupérer les champs personnalisés (colonnes) d'une liste noire.

    HTTP Request

    GET https://sarbacaneapis.com/v1/blacklists/{blacklistId}/fields

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les bounces

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces?offset=0&limit=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces?offset=0&limit=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contacts": [
            {
                "contact": [
                    "2017-09-18T08:11:57Z",
                    "2017-09-18T08:11:57Z",
                    "user@domain.com",
                    "+33600000001"
                ]
            },
            {
                "contact": [
                    "2017-09-15T12:35:00Z",
                    "2017-09-15T12:36:13Z",
                    "user1@domain.com",
                    "+33600000001"
                ]
            }
        ]
    }
    

    Permet de lister les contacts invalides d'une liste noire.

    HTTP Request

    GET https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste
    offset 0 Position du curseur [0-9]*
    limit 1 Nombre de contacts [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un bounce

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "2017-09-18T08:11:57Z",
        "2017-09-18T08:11:57Z",
        "user@domain.com",
        "+33600000001"
    }
    

    Permet d'ajouter un contact invalide dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces

    Body/Paramètres d’url :

    Parameter Default Description
    email null Adresse E-mail du contact
    phone null Numéro de mobile du contacte
    blacklistId null Id de la liste noire concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier un bounce

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'
    

    Custom Headers Authentication: curl curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces" -H "accountId: YOUR_ACCOUNTID" -H "apiKey: YOUR_API_KEY" -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contact": [
            "2017-09-18T08:17:17Z",
            "2017-09-15T12:35:00Z",
            "user_modified@domain.com",
            "+33600000001"
        ]
    }
    

    Permet de modifier un contact invalide dans une liste noire.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste
    email null E-mail du contact
    phone null Mobile du contact
    newEmail null Nouvel E-mail du contact
    newPhone null Nouveau Mobile du contact
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un bloc de bounces

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces/import"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces/import"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "invalid": 0,
        "valid": 2
    }
    

    Permet d'ajouter un bloc de contacts invalides (JSON) dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces/import

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    email null E-mail du contact
    phone null Mobile du contact
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer un bounce

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces?email=user@domain.com&phone=%2B33647474452"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces?email=user@domain.com&phone=%2B33647474452"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer un contact invalide dans une liste noire.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/blacklists/{blacklistId}/bounces

    Body/Paramètres d’url :

    Parameter Default Description
    blacklistId null Id de la liste noire concernée
    accountId null Id du compte
    apiKey null Clé API
    email null E-mail du contact
    phone null Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les désinscrits

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?offset=0&limit=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?offset=0&limit=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contacts": [
            {
                "contact": [
                    "2017-09-18T08:11:57Z",
                    "2017-09-18T08:11:57Z",
                    "user@domain.com",
                    "+33600000001"
                ]
            },
            {
                "contact": [
                    "2017-09-15T12:35:00Z",
                    "2017-09-15T12:36:13Z",
                    "user1@domain.com",
                    "+33600000001"
                ]
            }
        ]
    }
    

    Permet de lister les désinscrits d'une liste noire.

    HTTP Request

    GET https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste
    offset 0 Position du curseur [0-9]*
    limit 1 Nombre de contacts [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un désinscrit

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "2017-09-18T08:11:57Z",
        "2017-09-18T08:11:57Z",
        "user@domain.com",
        "+33600000001"
    }
    

    Permet d'ajouter un désinscrit dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers

    Body/Paramètres d’url :

    Parameter Default Description
    email null Adresse E-mail du contact
    phone null Numéro de mobile du contacte
    blacklistId null Id de la liste noire concernée
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier un désinscrit

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contact": [
            "2017-09-18T08:17:17Z",
            "2017-09-15T12:35:00Z",
            "user_modified@domain.com",
            "+33600000001"
        ]
    }
    

    Permet de modifier un désinscrit dans une liste noire.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    email null E-mail du contact
    phone null Mobile du contact
    newEmail null Nouvel E-mail du contact
    newPhone null Nouveau Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un bloc de désinscrits

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers/import"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers/import"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "invalid": 0,
        "valid": 2
    }
    

    Permet d'ajouter un bloc de désinscrits (JSON) dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers/import

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste noire concernée
    email null E-mail du contact
    phone null Mobile du contact
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer un désinscrit

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers?email=user@domain.com&phone=%2B33647474452"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers?email=user@domain.com&phone=%2B33647474452"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer un désinscrit dans une liste noire.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/blacklists/{blacklistId}/unsubscribers

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste
    email null E-mail du contact
    phone null Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Lister les plaignants

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?limit=10&offset=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?limit=10&offset=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contacts": [
            {
                "contact": [
                    "2017-09-18T08:11:57Z",
                    "2017-09-18T08:11:57Z",
                    "user@domain.com",
                    "+33600000001"
                ]
            },
            {
                "contact": [
                    "2017-09-15T12:35:00Z",
                    "2017-09-15T12:36:13Z",
                    "user1@domain.com",
                    "+33600000001"
                ]
            }
        ]
    }
    

    Permet de lister les contacts d'une liste noire.

    HTTP Request

    GET https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    blacklistId null Id de la liste
    offset 0 Position du curseur [0-9]*
    limit 1 Nombre de contacts [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter une plaignant

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000000"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "2017-09-18T08:11:57Z",
        "2017-09-18T08:11:57Z",
        "user@domain.com",
        "+33600000001"
    }
    

    Permet d'ajouter un plaignant dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints

    Body/Paramètres d’url :

    Parameter Default Description
    blacklistId null Id de la liste noire concernée
    email null Adresse E-mail du contact
    phone null Numéro de mobile du contacte
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Modifier un plaignant

    HTTP Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'
    

    Custom Headers Authentication:

    curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{"email": "user@domain.com", "phone": "+33600000001", "newEmail": "user_modified@domain.com"}'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "contact": [
            "2017-09-18T08:17:17Z",
            "2017-09-15T12:35:00Z",
            "user_modified@domain.com",
            "+33600000001"
        ]
    }
    

    Permet de modifier un plaignant dans une liste noire.

    HTTP Request

    PUT https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints

    Body/Paramètres d’url :

    Parameter Default Description
    blacklistId null Id de la liste noire concernée
    accountId null Id du compte
    apiKey null Clé API
    email null E-mail du contact
    phone null Mobile du contact
    newEmail null Nouvel E-mail du contact
    newPhone null Nouveau Mobile du contact
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter un bloc de plaignants

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints/import"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints/import"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '[ {"email": "user@domain.com", "phone": "+33600000001" }, {"email": "user2@domain.com", "phone": "+33600000002"} ] }'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "invalid": 0,
        "valid": 2
    }
    

    Permet d'ajouter un bloc de plaignants (JSON) dans une liste noire.

    HTTP Request

    POST https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints/import

    Body/Paramètres d’url :

    Parameter Default Description
    blacklistId null Id de la liste noire concernée
    accountId null Id du compte
    apiKey null Clé API
    email null E-mail du contact
    phone null Mobile du contact
    fieldId null Id d'une colonne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Supprimer un plaignant

    HTTP Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?email=user@domain.com&phone=%2B33647474452"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X DELETE "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints?email=user@domain.com&phone=%2B33647474452"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
    }
    

    Permet de supprimer un plaignant dans une liste noire.

    HTTP Request

    DELETE https://sarbacaneapis.com/v1/blacklists/{blacklistId}/complaints

    Body/Paramètres d’url :

    Parameter Default Description
    blacklistId null Id de la liste noire concernée
    accountId null Id du compte
    apiKey null Clé API
    email null E-mail du contact
    phone null Mobile du contact
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- Le service demandé est indisponible.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Campagnes

    Créer une campagne

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/campaigns"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '{ "name": "Name", "kind": "EMAIL" }'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/campaigns"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '{ "name": "Name", "kind": "EMAIL" }'
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "id":"kRzJCozIR1-U4F-r971haQ",
        "name":"Name"
    }
    

    Permet de créer une campagne.

    HTTP Request

    POST https://sarbacaneapis.com/v1/campaigns

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    name null Nom de la campagne
    kind null Type de campagne: EMAIL
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_CAMPAIGN_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Récupérer une campagne

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/campaigns/kRzJCozIR1-U4F-r971haQ"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/campaigns/kRzJCozIR1-U4F-r971haQ"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "campaign": {
            "blacklists": [
                "DEFAULT_BLACKLIST"
            ],
            "id": "kRzJCozIR1-U4F-r971haQ",
            "kind": "NORMAL",
            "modificationDate": "2018-07-27T08:06:48Z",
            "name": "Name",
            "sends": [
                "PRQ-IEN8Teq1QhPAuIL1kg"
            ],
            "sentDate": "0001-01-01T00:00:00Z",
            "split": {
                "splitDelay": 1,
                "splitDelayKind": "DAYS",
                "splitKind": "SENDER",
                "splitPercent": 20,
                "splitTriggerKind": "BESTOPENRATE"
            },
            "state": "DRAFTING",
            "tags": [
                "EMAIL"
            ],
            "unsubscription": {}
        }
    }
    

    Permet de récupérer une campagne.

    HTTP Request

    GET https://sarbacaneapis.com/v1/campaigns/{campaignId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    campaignId null Id de la campagne
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_CAMPAIGN_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Ajouter des destinataires

    HTTP Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/campaigns/kRzJCozIR1-U4F-r971haQ/recipients"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
      -d '[ { "email": "user1@domain.com", "phone": "+33600000001"}, { "email": "user2@domain.com", "phone": "+33600000002" } ]'
    

    Custom Headers Authentication:

    curl -X POST "https://sarbacaneapis.com/v1/campaigns/kRzJCozIR1-U4F-r971haQ/recipients"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
      -d '[ { "email": "user1@domain.com", "phone": "+33600000001"}, { "email": "user2@domain.com", "phone": "+33600000002" } ]'
    

    Response code:

    HTTP/2 200
    

    Response body:

    [
        {
            "email": "user1@domain.com",
            "phone": "+33600000001"
        },
        {
            "email": "user2@domain.com",
            "phone": "+33600000002"
        }
    ]
    
    

    Permet d'ajoutet des destinataires à une campagne.

    HTTP Request

    POST https://sarbacaneapis.com/v1/campaigns/kRzJCozIR1-U4F-r971haQ/recipients

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    campaignId null Id de la campagne
    email null E-mail du destinataire
    phone null Mobile du destinataire
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_CAMPAIGN_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Statistiques

    Lister vos campagnes

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/campaigns?offset=0&limit=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/campaigns?offset=0&limit=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    [
        {
            "count": 1827,
            "created": "2017-09-22T15:02:31Z",
            "edited": "2017-09-25T15:25:28Z",
            "id": "zqb26jJXSnywtCcX1Cj_HA",
            "kind": "SMS",
            "name": "Campagne sms"
        },
        {
            "count": 195668,
            "created": "2017-09-25T15:50:30Z",
            "edited": "2017-09-26T10:11:35Z",
            "id": "TEsK2AHJS-agbfdc-iDctQ",
            "kind": "NORMAL",
            "name": "Campagne E-mail 200k contacts"
        }
    ]
    
    

    Permet de récupérer toutes vos campagnes.

    HTTP Request

    GET https://sarbacaneapis.com/v1/campaigns

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    offset 0 Position du curseur [0-9]*
    limit max Nombre de campagnes [0-9]* - Max: 1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_LIST_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Récupérer les statistiques d'une campagne

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/reports/q8sErLkAS1eRjSmQkoaZcQ"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/reports/q8sErLkAS1eRjSmQkoaZcQ"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    {
        "values": {
            "V6UDRB2TRVKnCxwDqdQgrg": {
                "date": 1507013732,
                "id": "V6UDRB2TRVKnCxwDqdQgrg",
                "overview": {
                    "count": 1,
                    "device": {
                        "unknown": 2
                    },
                    "os": {
                        "values": {
                            "Unknown": 1
                        }
                    },
                    "read": {},
                    "shared": {},
                    "successes": 1
                }
            },
            "RXIn3nzJT0-4hsmKY1oUgQ": {
                "date": 1507013732,
                "id": "RXIn3nzJT0-4hsmKY1oUgQ",
                "overview": {
                    "bounces": 4,
                    "clickers": 34,
                    "clicks": 56,
                    "complaints": 2,
                    "count": 96,
                    "device": {
                        "desktop": 26,
                        "mobile": 28,
                        "unknown": 56
                    },
                    "openers": 30,
                    "opens": 47,
                    "os": {
                        "values": {
                            "Android": 6,
                            "BlackBerry": 6,
                            "IOS": 3,
                            "Linux": 5,
                            "Mac": 6,
                            "Others": 8,
                            "Windows": 3,
                            "WindowsPhone": 3
                        }
                    },
                    "read": {
                        "interest": 13
                    },
                    "shared": {},
                    "unsubscribers": 4
                }
            },
            "SUjbJSKbQXyutvcichdObA": {
                "date": 1507013732,
                "id": "SUjbJSKbQXyutvcichdObA",
                "overview": {
                    "bounces": 5,
                    "clickers": 6,
                    "clicks": 10,
                    "count": 100,
                    "device": {
                        "desktop": 9,
                        "mobile": 9,
                        "unknown": 84
                    },
                    "openers": 7,
                    "opens": 10,
                    "os": {
                        "values": {
                            "Android": 4,
                            "BlackBerry": 2,
                            "IOS": 2,
                            "Mac": 2,
                            "Others": 5,
                            "WindowsPhone": 1
                        }
                    },
                    "read": {
                        "interest": 14
                    },
                    "shared": {},
                    "unsubscribers": 4
                }
            }
        }
    }
    

    Permet de récupérer les statistiques de vos campagnes.

    HTTP Request

    GET https://sarbacaneapis.com/v1/reports/{campaignId}

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    campaignId null Id de la campagne concernée
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_LIST_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Récupérer les statistiques destinataires

    HTTP Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/reports/q8sErLkAS1eRjSmQkoaZcQ/recipients?offset=0&limit=2"
      -u "YOUR_ACCOUNTID:YOUR_API_KEY"
    

    Custom Headers Authentication:

    curl -X GET "https://sarbacaneapis.com/v1/reports/q8sErLkAS1eRjSmQkoaZcQ/recipients?offset=0&limit=2"
      -H "accountId: YOUR_ACCOUNTID"
      -H "apiKey: YOUR_API_KEY"
    

    Response code:

    HTTP/2 200
    

    Response body:

    [
        {
            "bounce": false,
            "clicks": 1,
            "complaint": false,
            "desktop": true,
            "links": {
                "http://www.sarbacane.com?utm_source=Sarbacane&utm_medium=EMAIL&utm_campaign=utmExample": 1
            },
            "mobile": false,
            "opens": 1,
            "recipient": {
                "email": "user1@domain.com",
                "fields": {
                    "CONTACT_ID": "8gk6_4LztM6sZMBCalLu3g",
                    "ORIGIN_CAPTION_ID": "usersList",
                    "ORIGIN_KIND_ID": "LIST",
                    "STATE_ID": "NORMAL"
                },
                "phone": ""
            },
            "replies": 0,
            "softs": 0,
            "success": false,
            "unsubscribe": false
        },
        {
            "bounce": false,
            "clicks": 1,
            "complaint": false,
            "desktop": true,
            "links": {
                "http://www.sarbacane.com?utm_source=Sarbacane&utm_medium=EMAIL&utm_campaign=utmExample": 1
            },
            "mobile": false,
            "opens": 1,
            "recipient": {
                "email": "user2@domain.com",
                "fields": {
                    "CONTACT_ID": "X4Idy9KQRcSQXss-Eqlj3Q",
                    "ORIGIN_CAPTION_ID": "usersList",
                    "ORIGIN_KIND_ID": "LIST",
                    "STATE_ID": "NORMAL"
                },
                "phone": ""
            },
            "replies": 0,
            "softs": 0,
            "success": false,
            "unsubscribe": false
        }
    ]
    

    Permet de récupérer, destinataire par destinataire, les statistiques de vos campagnes.

    HTTP Request

    GET https://sarbacaneapis.com/v1/reports/{campaignId}/recipients

    Body/Paramètres d’url :

    Parameter Default Description
    accountId null Id du compte
    apiKey null Clé API
    campaignId null Id de la campagne concernée
    offset 0 Position du curseur [0-9]*
    limit 1 Nombre de contacts [0-9]* - Max:1000
    Code Erreur Signification
    401 NEED_ACCOUNT_ID -- Aucun ID de compte n'est spécifié dans la requête.
    401 NEED_API_KEY -- Aucune clé API n'est spécifiée dans la requête.
    401 API_KEY_UNAUTHORIZED -- Clé API invalide.
    404 SERVICE_*_UNREACHABLE -- L'Url demandé est invalide.
    500 INTERNAL_SERVER_ERROR -- Erreur interne, merci de contacter le support.

    Webhooks

    Activation du service

    Webhooks

    Configuration

    Webhooks2

    1. Donnez un nom à ce webhook, vous pourrez ainsi identifier vos différents webhooks s'il y a lieu d'en gérer plusieurs.

    2. Cochez les événements pour lesquels vous souhaitez recevoir les mises à jour.

    3. Indiquez l'URL sur laquelle ces informations seront transmises (HTTP POST).

    4. Validez votre configuration: vous recevrez automatiquement une enveloppe JSON de test, afin de vérifier si les paramètres sont cohérents: {"email":"recipient@sarbacane.com"}

    Enveloppe JSON

    Pour chaque événement, vous recevrez une enveloppe JSON avec un type identifiable. Cette enveloppe sera transmise sur l'URL que vous aurez renseignée, via une requête HTTP POST. Le JSON sera dans le body (DATA) de la requête.

    Les différents types d'événement sont:

    Parameter Value Description
    type delivered E-mail reçu
    type soft_bounce E-mail en echec temporaire
    type hard_bounce E-mail en echec définitif
    type open E-mail ouvert
    type click E-mail cliqué
    type unsubscribe Désinscription
    type complaint Plainte

    Vous retrouverez dans le reste de l'enveloppe tout ou partie des paramètres suivants:

    Parameter Description Example
    campaignId Id de la campagne concernée "campaignId": "EDE18BYwQwqYA9_BKyTsVr"
    date Date de l'événement "date": "2018-01-17T11:21:59.314Z"
    email E-mail du destinataire "email": "recipient@domain.com"
    from E-mail de l'expéditeur "from": "sender@domain.com"
    sendId Id de l'envoi "sendId": "BbJ-n53VQ-2_3i5ewR111R"
    subject Sujet du message "subject": "30% off !"
    category Type de refus "category": "RELAYING_ISSUES"
    returnCode Code retour "returnCode": -1
    smtpDescription Description de l'erreur SMTP "smtpDescription": "There are no DNS entries for the hostname tgipimail.com. I cannot determine where to send this message."
    browser Type de navigateur "browser": "CHROME 63.0.3239.132"
    language Langue du navigateur "language": "en,en-US;q=0.9,fr-FR;q=0.8,fr;q=0.7"
    operatingSystem Système d'exploitation "operatingSystem": "WINDOWS"
    webmail Type de webmail "webmail": "Unknown"