NAV
curl

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

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


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

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

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

Listes de contacts

Lister les listes

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
  {
      "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter une liste

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nom de la liste
teams non Tableau contenant les ids des groupes à associer à la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier une liste

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet de modifier une liste de contacts.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Paramètres de Body

Paramètre Requis Description
name non Nom de la liste
readOnly non Permet de mettre la liste en lecture seule

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer une liste

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer une liste de contacts.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les teams d'une liste

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à une liste.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'une liste

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/lists/{listId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à une liste.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer à la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les champs personnalisés

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un champ

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Paramètres de Body

Paramètre Requis Description
kind oui STRING, BOOL, INT ou DATE
caption oui Nom de la colonne

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier un champ

Authentification HTTP

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

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet de modifier un champ.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste
fieldId oui Id du champ personnalisé

Paramètres de Body

Paramètre Requis Description
kind oui STRING, BOOL, INT ou DATE
caption oui Nom de la colonne

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez 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"

Code réponse HTTP de succès

HTTP/2 200

Response body :


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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste
fieldId oui Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez 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"

Code réponse HTTP de succès

HTTP/2 200

Response body :


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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les contacts

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
email non Adresse e-mail
phone non Numéro de téléphone
start non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)
end non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)
search non Rechercher du texte dans les champs des contacts

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un contact

Authentification HTTP:

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" }'

Authentification par Headers HTTP:

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" }'

Code réponse HTTP de succès:

HTTP/2 200

Body de réponse:

[
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier un contact

Authentification HTTP

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"}'

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier un contact dans une liste.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste
contactId oui Id du contact

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter/Modifier un contact

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    "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 ou de mettre à jour un contact dans une liste. Si le contact n'existe pas, il sera ajouté. S'il existe, il sera mis à jour. Est considéré comme un contact un couple unique e-mail / phone.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un bloc de contacts (JSON)

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/lists/{listId}/contacts/import"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '[{"email": "user1@domain.com", "phone": "+33600000001", "nvVhK7dwSJyPAbFKrfUtjw": "18 rue de la plage 33000 BORDEAUX" }, \
        {"email": "user2@domain.com", "phone": "+33600000002", "nvVhK7dwSJyPAbFKrfUtjw": "05 rue de Tourcoing 59000 LILLE" }, \
        {"email": "user3@domain.com", "phone": "+33600000003", "nvVhK7dwSJyPAbFKrfUtjw": "115 boulevard émile Zola 69000 LYON" } ]'

Authentification par Headers HTTP

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", "nvVhK7dwSJyPAbFKrfUtjw": "18 rue de la plage 33000 BORDEAUX" }, \
    {"email": "user2@domain.com", "phone": "+33600000002", "nvVhK7dwSJyPAbFKrfUtjw": "05 rue de Tourcoing 59000 LILLE" }, \
    {"email": "user3@domain.com", "phone": "+33600000003", "nvVhK7dwSJyPAbFKrfUtjw": "115 boulevard émile Zola 69000 LYON" } ]'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet d'ajouter un bloc (JSON) de contacts (Max: 4MB par requête). Il est possible de passer un paramètre dans l'URL afin de passer en UPSERT (?upsert=true). Ainsi, les contacts n'existant pas seront créés, ceux existant mis à jour. Est considéré comme un contact un couple unique e-mail / phone.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Paramètres de Body

Paramètre Requis Description
upsert non Option d'upsert: ?upsert=true
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer un contact

Authentification HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts/{contactId}"
  -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"

Authentification par Headers HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/lists/{listId}/contacts/{contactId}"
  -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"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
}

Permet de supprimer un contact dans une liste.

Requête HTTP

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

DELETE https://sarbacaneapis.com/v1/lists/{listId}/contacts?email={contactEmail}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste
contactId non Id du contact
email non Adresse e-mail
phone non Numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Vider une liste

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
listId oui Id de la liste

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Listes noires

Lister les listes noires

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter une liste noire

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nom de la liste noire
teams non Tableau contenant les ids des groupes à associer à la liste noire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier une liste noire

Authentification HTTP

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

Authentification par Headers HTTP

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", "readOnly": false}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet de modifier une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
name non Nom de la liste noire
readOnly non Mettre la liste en lecture seule

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer une liste noire

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
}

Permet de supprimer une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les teams d'une blacklist

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'une blacklist

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/blacklists/{blacklistId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer à la liste noire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les champs personnalisés des listes noires

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les bounces

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
email non Adresse e-mail
phone non Numéro de téléphone
start non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)
end non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un bounce

Authentification HTTP

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

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "LH8XG_jpRS2J6fLW_U11WA"
}

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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
blacklistId oui Id de la liste noire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier un bounce

Authentification HTTP

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"}'

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
newEmail non Nouvelle adresse e-mail
newPhone non Nouveau numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un bloc de bounces

Authentification HTTP

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"} ]'

Authentification par Headers HTTP

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"} ]'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet d'ajouter un bloc de contacts invalides (JSON) dans une liste noire (Max: 4MB par requête).

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer un bounce

Authentification HTTP

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

Authentification par Headers HTTP

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"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
}

Permet de supprimer un contact invalide dans une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
email non Adresse e-mail
phone non Numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les désinscrits

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
email non Adresse e-mail
phone non Numéro de téléphone
start non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)
end non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un désinscrit

Authentification HTTP

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

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "LH8XG_jpRS2J6fLW_U11WA"
}

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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier un désinscrit

Authentification HTTP

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"}'

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
newEmail non Nouvelle adresse e-mail
newPhone non Nouveau numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un bloc de désinscrits

Authentification HTTP

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"} ]'

Authentification par Headers HTTP

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"} ]'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet d'ajouter un bloc de désinscrits (JSON) dans une liste noire (Max: 4MB par requête).

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer un désinscrit

Authentification HTTP

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

Authentification par Headers HTTP

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"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
}

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

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
email non Adresse e-mail
phone non Numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les plaignants

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
email non Adresse e-mail
phone non Numéro de téléphone
start non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)
end non Filtre sur la date de modification (Date ISO: 2019-04-25T08:31:43.280Z)

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un plaignant

Authentification HTTP

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

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "LH8XG_jpRS2J6fLW_U11WA"
}

Permet d'ajouter un plaignant dans une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier un plaignant

Authentification HTTP

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"}'

Authentification par Headers HTTP

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"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
newEmail non Nouvelle adresse e-mail
newPhone non Nouveau numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter un bloc de plaignants

Authentification HTTP

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"} ]'

Authentification par Headers HTTP

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"} ]'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet d'ajouter un bloc de plaignants (JSON) dans une liste noire (Max: 4MB par requête).

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone
fieldId non Id du champ personnalisé

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer un plaignant

Authentification HTTP

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

Authentification par Headers HTTP

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"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
}

Permet de supprimer un plaignant dans une liste noire.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
blacklistId oui Id de la liste noire
email non Adresse e-mail
phone non Numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Campagnes

Créer une campagne E-mail

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/email"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{
    "name": "Name",
    "emailFrom": "contact@email.com",
    "aliasFrom": "From",
    "emailReplyTo": "contact@email.com",
    "aliasReplyTo": "Reply To",
    "subject": "Subject",
    "preheader": "Preheader"
  }'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/email"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{
    "name": "Name",
    "emailFrom": "contact@email.com",
    "aliasFrom": "From",
    "emailReplyTo": "contact@email.com",
    "aliasReplyTo": "Reply To",
    "subject": "Subject",
    "preheader": "Preheader"
  }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet de créer une campagne E-mail.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Le nom de la campagne
emailFrom oui E-mail de l'expéditeur
aliasFrom oui Alias de l'expéditeur
emailReplyTo oui E-mail de réponse
aliasReplyTo oui Alias de réponse
subject oui Objet de l'e-mail
preheader non Preheader de l'e-mail
teams non Tableau contenant les ids des groupes à associer à la campagne

Codes erreur

Code HTTP Erreur Description
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
403 PREHEADER_FEATURE_MISSING Ajout d'un preheader non autorisé
404 SERVICE_*_UNREACHABLE Le service demandé est indisponible
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Créer une campagne SMS

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/sms"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{
    "name": "Name",
    "kind": "SMS_NOTIFICATION",
    "content": "Inscription validée !"
  }'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/sms"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{
    "name": "Name",
    "kind": "SMS_MARKETING",
    "smsFrom": "YOURCOMPANY",
    "content": "Solde: -20% dès ce soir !"
  }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet de créer une campagne SMS.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Le nom de la campagne
kind oui SMS_MARKETING ou SMS_NOTIFICATION
smsFrom non Expediteur personnalisé du sms (entre 3 et 11 caractères alpha-numériques)
content oui Contenu du sms Max: 450 caractères table GSM
teams non Tableau contenant les ids des groupes à associer à la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Liste des campagnes

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "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.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
search non Rechercher du texte dans le nom ou l'objet de la campagne
state non DRAFT, FINISH, ROUTING ou MODERATION

Codes erreur

Code HTTP Erreur Description
400 INVALID_CAMPAIGNS_LIST_STATE L'état de campagne spécifié dans la requête est invalide
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 au service, veuillez contacter le support

Détails d'une campagne

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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",
        "state": "DRAFTING",
        "tags": [
            "EMAIL"
        ],
        "unsubscription": {}
    }
}

Permet de récupérer le détail d'une campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Lister les teams d'une campagne

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à une campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'une campagne

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/campaigns/{campaignId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/campaigns/{campaignId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à une campagne.

Requête HTTP

PUT https://sarbacaneapis.com/v1/campaigns/{campaignId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer à la campagne

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Associer une/plusieurs liste(s) noire(s)

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/blacklists"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{
    "blacklistIds": [
      "rZskDacLS4-v4q-X2whMbP",
      "zRtDrmirReerskYVAz9o1A"
    ]
  }'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/blacklists"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{ "blacklistIds": [
    "rZskDacLS4-v4q-X2whMbP",
    "zRtDrmirReerskYVAz9o1A"
  ]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
  "blacklistIds": [
      "rZskDacLS4-v4q-X2whMbP",
      "zRtDrmirReerskYVAz9o1A"
  ],
}

Permet d'associer une/plusieurs liste(s) noire(s) à la campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/blacklists

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Paramètres de Body

Paramètre Requis Description
blacklistIds oui Liste d'ids de listes noires (Tableau [ {}, {} ])

Codes erreur

Code HTTP Erreur Description
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 ITEM_NOT_FOUND La ressource nécessaire à l'opération n'existe pas
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Importer une liste

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/list"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{
    "listId": "rZskDacLS4-v4q-X2whMbP"
  }'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/list"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{
    "listId": "rZskDacLS4-v4q-X2whMbP"
  }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet d'importer la copie d'une liste de contacts dans la campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/list

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Paramètres de Body

Paramètre Requis Description
listId oui Id de la liste

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Importer un modèle

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/content"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{
    "templateId": "md1166aAQXOItlDLcBzyQA"
  }'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/content"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{ "templateId": "md1166aAQXOItlDLcBzyQA" }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet d'importer la copie d'un modèle dans la campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/content

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Paramètres de Body

Paramètre Requis Description
templateId oui Id du template

Codes erreur

Code HTTP Erreur Description
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 ITEM_NOT_FOUND La ressource nécessaire à l'opération n'existe pas
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Ajouter des destinataires

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

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

Permet d'ajouter des destinataires dans la campagne (Max: 4MB par requête).

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/recipients

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Paramètres de Body

Paramètre Requis Description
email non Adresse e-mail
phone non Numéro de téléphone

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Lister les destinataires

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}/recipients"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}/recipients"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "id": "qYCnj6VoQA2rD9stZMJ5-Q",
        "email": "user1@domain.com",
        "phone": "+33600000001"
    },
    {
        "id": "pQLje5XpRB4zU5hwPOMR2-K",
        "email": "user2@domain.com",
        "phone": "+33600000002"
    }
]

Permet de lister les destinataires de la campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Lister les champs destinataires

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/campaigns/{campaignId}/recipients/fields"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "id": "CONTACT_ID",
        "caption": "ID",
        "kind": ""
    },
    {
        "id": "STATE_ID",
        "caption": "State",
        "kind": ""
    },
    {
        "id": "ORIGIN_KIND_ID",
        "caption": "Origin Kind",
        "kind": ""
    },
    {
        "id": "ORIGIN_CAPTION_ID",
        "caption": "Origin Caption",
        "kind": ""
    },
    {
        "id": "EMAIL_CORRECTION_ID",
        "caption": "Email Correction",
        "kind": ""
    },
    {
        "id": "PHONE_CORRECTION_ID",
        "caption": "Phone Correction",
        "kind": ""
    },
    {
        "id": "EMAIL_ID",
        "caption": "",
        "kind": ""
    },
    {
        "id": "PHONE_ID",
        "caption": "",
        "kind": ""
    },
    {
        "id": "CIVILITY_ID",
        "caption": "Civilité",
        "kind": "STRING"
    },
    {
        "id": "FIRSTNAME_ID",
        "caption": "Prénom",
        "kind": "STRING"
    },
    {
        "id": "LASTNAME_ID",
        "caption": "Nom",
        "kind": "STRING"
    },
    {
        "id": "RH6YoMoXQJKCDlKF6wKbCg",
        "caption": "adresse",
        "kind": "STRING"
    }
]

Permet de lister les champs personnalisés des destinataires de la campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Ajouter un contenu

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/send/{sendId}/content"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{ "html":"<html />", "text": "text" }'
'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/send/{sendId}/content"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{ "html":"<html />", "text": "text" }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet d'ajouter un contenu HTML/Texte à l'envoi spécifié. Vous devez au préalable récupèrer l'id de l'envoi concerné (sendId): dans le cadre d'une campagne STANDARD, il n'y a qu'un seul sendId par campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/send/{sendId}/content

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne
sendId oui Id du send de campagne

Paramètres de Body

Paramètre Requis Description
html non Contenu HTML du send de campagne
text non Contenu texte du send de campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Envoyer une campagne

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/send"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/send"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{ "requestedSendDate": "2019-04-25T08:31:43.280Z" }'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "webcopy": "http://eye.sarbinteg.com/"
}

Permet d'envoyer (ou de programmer) une campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/send

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Paramètres de Body

Paramètre Requis Description
requestedSendDate non Date ISO de programmation (ex: "2019-04-25T08:31:43.280Z")

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Supprimer une campagne

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer une campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Codes erreur

Code HTTP Erreur Description
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
409 CAMPAIGN_USED_IN_AUTOMATION La campagne ne peut pas être supprimée car une campagne automatique l'utilise
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Annuler l'envoi d'une campagne

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/cancel"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/campaigns/{campaignId}/cancel"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet d'annuler l'envoi d'une campagne.

Requête HTTP

POST https://sarbacaneapis.com/v1/campaigns/{campaignId}/cancel

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Campagnes automatiques

Lister vos campagnes automatiques

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/automations?search=campaign"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/automations?search=campaign"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "count": 0,
        "created": "2018-06-28T08:14:03Z",
        "edited": "2018-06-28T08:14:47Z",
        "id": "otFSLkt7TBSWjyOh753S5Q",
        "kind": "WELCOME",
        "list": "List Automation example #1",
        "name": "Automation example #1",
        "status": "DISABLE",
        "steps": [
            {
                "id": "N0AVjMPbRyyclTuTnSSNrw",
                "subject": "Welcome!",
                "type": "EMAIL"
            }
        ]
    },
    {
        "count": 0,
        "created": "2018-07-26T13:52:28Z",
        "edited": "2018-07-27T09:57:14Z",
        "id": "F3tC6G8lReyu09ePqGQGgg",
        "kind": "WELCOME",
        "list": "Campagne AUTO / 20180726",
        "name": "Campagne Auto 20180726",
        "status": "ENABLED",
        "steps": [
            {
                "id": "j7VKryzgSuGY7z_yStGnvA",
                "subject": "Automation - first message",
                "type": "EMAIL"
            }
        ]
    }
]

Permet de récupérer toutes vos campagnes automatiques.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000
search non Rechercher du texte dans le nom de la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier le nom d'une campagne automatique

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/automations/{automationId}/name"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/automations/{automationId}/name"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier le nom d'une campagne automatique.

Requête HTTP

PUT https://sarbacaneapis.com/v1/automations/{automationId}/name

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nouveau nom de la campagne automatique

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Supprimer une campagne automatique

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer une campagne automatique.

Requête HTTP

DELETE https://sarbacaneapis.com/v1/automations/{automationId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
automationId oui Id de la campagne automatique

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Désactiver une campagne automatique

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/automations/{automationId}/deactivate"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/automations/{automationId}/deactivate"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de désactiver une campagne automatique.

Requête HTTP

POST https://sarbacaneapis.com/v1/automations/{automationId}/deactivate

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
automationId oui Id de la campagne automatique

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Lister les teams d'une campagne automatique

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/automations/{automationId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/automations/{automationId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à une campagne automatique.

Requête HTTP

GET https://sarbacaneapis.com/v1/automations/{automationId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'une campagne automatique

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/automations/{automationId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/automations/{automationId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à une campagne automatique.

Requête HTTP

PUT https://sarbacaneapis.com/v1/automations/{automationId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer à la campagne automatique

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Statistiques

Statistiques de campagne

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "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 générales d'une campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Statistiques destinataires

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "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 d'une campagne.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
campaignId oui Id de la campagne
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modèles

Lister vos modèles

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "count": X,
    "templates": [
        {
            "id": "md1166aAQXOItlDLcBzyQA",
            "name": "Name",
            "createdAt": "2019-01-01T00:00:00Z",
            "updatedAt": "2019-01-01T00:00:00Z",
        }
    ]
}

Permet de récupérer toutes vos campagnes automatiques.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier les groupes

Authentification HTTP

curl -X PATCH "https://sarbacaneapis.com/v1/templates/{templateId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"name":"new name","teams":["9cee994b1836fe00018126b4"]}'

Authentification par Headers HTTP

curl -X PATCH "https://sarbacaneapis.com/v1/templates/{templateId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"name":"new name","teams":["9cee994b1836fe00018126b4"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les groupes ayant accès au modèle.

Requête HTTP

PATCH https://sarbacaneapis.com/v1/templates/{templateId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
templateId oui Id du modèle

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer au modèle
name non Nom du modèle

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Lister les teams d'un modèle

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/templates/{templateId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/templates/{templateId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à un modèle.

Requête HTTP

GET https://sarbacaneapis.com/v1/templates/{templateId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'un modèle

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/templates/{templateId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/templates/{templateId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à un modèle.

Requête HTTP

PUT https://sarbacaneapis.com/v1/templates/{templateId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer au modèle

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Formulaires

Lister vos formulaires

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "id": "md1166aAQXOIdsDLcBzyQA",
        "name": "Name"
    }
]

Permet de récupérer toutes vos formulaires.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Détails d'un formulaire

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/forms/{formId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/forms/{formId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "md1166aAQXOIdsDLcBzyQA",
    "name": "Name"
}

Permet de récupérer le détail d'une formulaire.

Requête HTTP

GET https://sarbacaneapis.com/v1/forms/{formId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
formId oui Id du formulaire

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier le nom d'un formulaire

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/forms/{formId}/name"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/forms/{formId}/name"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier le nom d'un formulaire.

Requête HTTP

PUT https://sarbacaneapis.com/v1/forms/{formId}/name

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nouveau nom du formulaire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les teams d'un formulaire

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/forms/{formId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/forms/{formId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à un formulaire.

Requête HTTP

GET https://sarbacaneapis.com/v1/forms/{formId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'un formulaire

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/forms/{formId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/forms/{formId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à un formulaire.

Requête HTTP

PUT https://sarbacaneapis.com/v1/forms/{formId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer au formulaire

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Landings pages

Lister vos landings pages

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

[
    {
        "id": "md1166aAQXOIdsDLcBzyQA",
        "name": "Name",
        "createdAt": "2019-01-01T00:00:00Z",
        "updatedAt": "2019-01-01T00:00:00Z",
    }
]

Permet de récupérer toutes vos landings pages.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 1 000

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Détails d'une landing page

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/landings/{landingId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/landings/{landingId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "md1166aAQXOIdsDLcBzyQA",
    "name": "Name",
    "createdAt": "2019-01-01T00:00:00Z",
    "updatedAt": "2019-01-01T00:00:00Z",
}

Permet de récupérer le détail d'une landing page.

Requête HTTP

GET https://sarbacaneapis.com/v1/landings/{landingId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
landingId oui Id de la landing page

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier le nom d'une landing page

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/landings/{landingId}/name"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/landings/{landingId}/name"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"name": ["Name 1"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier le nom d'une landing page.

Requête HTTP

PUT https://sarbacaneapis.com/v1/landings/{landingId}/name

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nouveau nom de la landing page

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Lister les teams d'une landing page

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/landings/{landingId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/landings/{landingId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
      "9cee994b1836fe00018126b1",
      "9cee994b1836fe00018126b2"
    ]
}

Permet de récupérer les teams associées à une landing page.

Requête HTTP

GET https://sarbacaneapis.com/v1/landings/{landingId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les teams d'une landing page

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/landings/{landingId}/teams"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/landings/{landingId}/teams"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teams": ["9cee994b1836fe00018126b1", "9cee994b1836fe00018126b2"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les teams associées à une landing page.

Requête HTTP

PUT https://sarbacaneapis.com/v1/landings/{landingId}/teams

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
teams oui Tableau contenant les ids des groupes à associer à la landing page

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez 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.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:-

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

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

Paramètre Description Exemple
campaignId Id de la campagne "campaignId": "EDE18BYwQwqYA9_BKyTsVr"
date Date de l"événement "date": "2018-01-17T11:21:59.314Z"
email E-mail du destinataire "email": "recipient.com"
from E-mail de l"expéditeur "from": "sender.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
operatingSystem Système d'exploitation "operatingSystem": "WINDOWS"
webmail Type de webmail "webmail": "Unknown"

Contacts

Detecter les champs email et téléphone de contacts

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/contacts/fields/detect"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"locale": "fr-FR", "content": ["John;Doe;john.doe@sarbacane.com;0601020304", "Jane;Doe;jane.doe@sarbacane.com;0605060708"]}'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/contacts/fields/detect"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"locale": "fr-FR", "content": ["John;Doe;john.doe@sarbacane.com;0601020304", "Jane;Doe;jane.doe@sarbacane.com;0605060708"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "email": 2,
    "phone": 3
}

Permet de détecter les champs email et téléphone dans un tableau de contacts.

Requête HTTP

POST https://sarbacaneapis.com/v1/contacts/fields/detect

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
locale non Paramètre de région pour la détection des numéros de téléphone
content oui Liste de contacts. Les champs peuvent être séparés par des point-virgules, virgules ou tabulations. Le tableau doit contenir moins de 20 entrées.

Codes erreur

Code HTTP Erreur Description
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 FAILED TO ACQUIRE LOCK La cible est en cours d'utilisation par une autre ressource
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Consommation

Lister les consommations

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/settings/transactions/search"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"sort":{"orderBy":"TRANSACTION_DATE","asc":false},"filter":{"minDate":"2019-01-01T23:00:00.000Z","maxDate":"2020-01-01T22:59:59.999Z","range":{"origin":0,"length":100},"search":"Campaign name","users":["V6UDRB2TRVKnCxwDqdQgrg","W6UDRB2TRVKnCxwDqdQgrw"],"teamIds":[],"includeTags":["EMAIL","TEST"],"excludeTags":["TRANSACTIONAL","SMS"]}}'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/settings/transactions/search"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"sort":{"orderBy":"TRANSACTION_DATE","asc":false},"filter":{"minDate":"2019-01-01T23:00:00.000Z","maxDate":"2020-01-01T22:59:59.999Z","range":{"origin":0,"length":100},"search":"Campaign name","users":["V6UDRB2TRVKnCxwDqdQgrg","W6UDRB2TRVKnCxwDqdQgrw"],"teamIds":[],"includeTags":["EMAIL","TEST"],"excludeTags":["TRANSACTIONAL","SMS"]}}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
  "totalEmailConsumption": 1,
  "totalSmsConsumption": 1,
  "count": 1,
  "transactions": [
    {
      "accountId": "A6UdRB2TRVKnCxwDqdQgra",
      "userId": "W6UDRB2TRVKnCxwDqdQgrw",
      "campaignId": "C6UdRB2TRVKnCxwDqdQgrc",
      "type": "ROUTING",
      "date": "2019-12-23T11:14:18.331Z",
      "username": "John Doe",
      "creditType": "EMAIL",
      "credits": -1,
      "creditsLeft": 50896,
      "campaignName": "Campaign Name",
      "tags": [
        "TEST",
        "EMAIL"
      ]
    },
    {
      "accountId": "A6UdRB2TRVKnCxwDqdQgra",
      "userId": "W6UDRB2TRVKnCxwDqdQgrw",
      "campaignId": "d6UdRB2TRVKnCxwDqdQgrc",
      "type": "ROUTING",
      "date": "2019-12-23T11:14:17.331Z",
      "username": "John Doe",
      "creditType": "SMS",
      "credits": -1,
      "creditsLeft": 20896,
      "campaignName": "SMS Campaign Name",
      "tags": [
        "TEST",
        "SMS"
      ]
    }
  ]
}

Permet de récupérer les consommations des utilisateurs ou des groupes associés à votre compte.

Requête HTTP

POST https://sarbacaneapis.com/v1/settings/transactions/search

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
sort oui Json contenant les paramètres "orderBy" et "asc" expliqués ci-après
sort.orderBy oui Ordre des consommations, valeurs possibles : "TRANSACTION_DATE", "USER_NAME", "TEAM_NAME" et "CREDITS"
sort.asc oui Tri ascendant ou descendant, valeurs possibles : true et false
filter oui Json contenant les paramètres "minDate", "maxDate", "range", "search", "users", "teamIds", "includeTags" et "excludeTags" expliqués ci-après
filter.minDate oui Filtre sur la date de début (Date ISO: 2019-04-25T08:31:43.280Z)
filter.maxDate oui Filtre sur la date de fin (Date ISO: 2019-04-25T08:31:43.280Z)
filter.range oui Json contenant les paramètres "origin" et "length" expliqués ci-après
filter.range.origin oui Index du premier item - Min: 0
filter.range.length oui Nombre d'éléments retournés - Max: 10 000
filter.users oui Tableau contenant des ids d'utilisateurs, la recherche se fait soit par users soit par teamIds mais au moins l'un des deux est requis
filter.teamIds oui Tableau contenant des ids de groupes, la recherche se fait soit par users soit par teamIds mais au moins l'un des deux est requis
filter.includeTags non Tableau contenant les tags à inclure lors de la recherche, valeurs possibles : "EMAIL", "SMS", "TRANSACTIONAL" (Campagne automatiques) et "TEST". Un tag ne doit pas être inclus et exclus en même temps. Valeur par défaut : tous les tags sont inclus.
filter.excludeTags non Tableau contenant les tags à exclude lors de la recherche, valeurs possibles : "EMAIL", "SMS", "TRANSACTIONAL" (Campagne automatiques) et "TEST". Un tag ne doit pas être inclus et exclus en même temps. Valeur par défaut : aucun tag n'est exclu.
filter.search non Chaine de caractère permettant de rechercher un nom de campagne ou le nom du message d'une campagne automatique

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Groupes

Lister les groupes

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/teams?offset=0&limit=2&desc=true&search=groupe"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "teams": [
        {
            "id": "6eee994b1836fe00018126e2",
            "accountId": "6953a148b85b537094a0512d",
            "name": "Default team",
            "users": [
                "777744e06cc68528289e0b0d",
                "88882e26b6cc6852828d47a4d"
            ],
            "creationDate": "2017-08-22T15:39:56Z"
        },
        {
            "id": "7d02496a6bffc901012ecd5d",
            "accountId": "2953a148b85b537094a0515d",
            "name": "The best team",
            "creationDate": "2017-08-23T15:39:56Z"
        }
    ]
}

Permet de récupérer tous les groupes associés à votre compte.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 100 000
search non Filtre les groupes par nom
desc non Tri par ordre décroissant de date de création des groupes - Valeurs possibles : true et false

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Récupérer un groupe

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/teams/{teamId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/teams/{teamId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "team": {
        "id": "7eee994b1836fe00018126b3",
        "accountId": "6953a148b85b537094a0515de",
        "name": "Default team",
        "users": [
            "606744e06cc68528289e0b00",
            "2382e26b6cc6852828d47a4e"
        ],
        "creationDate": "2017-08-22T15:39:56Z"
    }
}

Permet de récupérer un groupe.

Requête HTTP

GET https://sarbacaneapis.com/v1/teams/{teamId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Créer un groupe

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "id": "6e1848a2e8b1ef00018ad2fd"
}

Permet de créer un groupe associé à votre compte.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
name oui Nom du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier le nom d'un groupe

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"name":"TEAM_NAME"}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"name":"TEAM_NAME"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier le nom d'un groupe.

Requête HTTP

PUT https://sarbacaneapis.com/v1/teams/{teamId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Paramètres de Body

Paramètre Requis Description
name oui Nom du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Supprimer un groupe

Authentification HTTP

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

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer un groupe.

Requête HTTP

DELETE https://sarbacaneapis.com/v1/teams/{teamId}

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier les utilisateurs d'un groupe

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/users/team"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"userIds":["576744e06cc68528289e0b0e"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/users/team"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"userIds":["576744e06cc68528289e0b0e"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les utilisateurs d'un groupe.

Requête HTTP

PUT https://sarbacaneapis.com/v1/teams/{teamId}/users/team

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Paramètres de Body

Paramètre Requis Description
userIds oui Tableau contenant des ids d'utilisateurs

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier les invitations à un groupe

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/invitations/team"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"invitations":["johndoe@johndoe.com"]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/invitations/team"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"invitations":["johndoe@johndoe.com"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les invitations à un groupe.

Requête HTTP

PUT https://sarbacaneapis.com/v1/teams/{teamId}/invitations/team

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Paramètres de Body

Paramètre Requis Description
invitations oui Tableau contenant les adresses email à inviter au groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Récupérer les limites de crédits

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "creditLimits": [
        {
            "creditType": "EMAIL",
            "count": 10000,
            "period": "MONTH"
        },
        {
            "creditType": "SMS",
            "count": 12500,
            "period": "YEAR"
        }
    ]
}

Permet de récupérer les limites de crédits d'un groupe.

Requête HTTP

GET https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier les limites de crédits

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"creditLimits":[{"creditType":"EMAIL","count":100,"period":"MONTH"},{"creditType":"SMS","count":200,"period":"YEAR"}]}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"creditLimits":[{"creditType":"EMAIL","count":100,"period":"MONTH"},{"creditType":"SMS","count":200,"period":"YEAR"}]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier les limites de crédits d'un groupe.

Requête HTTP

PUT https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Paramètres de Body

Paramètre Requis Description
creditLimits true Tableau contenant des entrées Json représentant une limitation de crédits. Les paramètres Json "creditType", "count" et "period" sont expliqués ci-après
creditType true Paramètres d'un item Json du tableau creditLimits, type de crédit, valeurs possibles : "EMAIL" ou "SMS"
count true Paramètres d'un item Json du tableau creditLimits, valeur numérique représentant la limite de crédits
period true Paramètres d'un item Json du tableau creditLimits, période de la limite, valeurs possibles : "MONTH" ou "YEAR"

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Supprimer les limites de crédits

Authentification HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer toutes les limites de crédits d'un groupe.

Requête HTTP

DELETE https://sarbacaneapis.com/v1/teams/{teamId}/creditLimits

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
teamId oui Id du groupe

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Utilisateurs

Lister les utilisateurs

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/users?offset=0&limit=2&desc=true&search=utilisateur"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

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

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "users": [
        {
            "userId": "54fez56f4ez65fez465fez4e",
            "email": "user1@email.com",
            "firstName": "Firstname",
            "lastName": "Lastname",
            "type": "OWNER",
            "groupId": "re4g984eg89r4g894fez984a",
            "validated": true
        }
    ],
    "invitations": [
        {
            "email": "user2@email.com",
            "firstName": "Firstname",
            "lastName": "Lastname",
            "type": "USER",
            "groupId": "",
            "validated": false
        }
    ]
}

Permet de récupérer tous les utilisateurs.

Requête HTTP

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

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
offset non Position de départ
limit non Nombre maximum d'éléments retournés - Max: 100 000
search non Filtre les utilisateurs par nom ou email
desc non Tri par ordre décroissant de date de création des utilisateurs - Valeurs possibles : true et false

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Inviter un utilisateur

Authentification HTTP

curl -X POST "https://sarbacaneapis.com/v1/users/invite"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"teamId":"576244e06cc68528289e0b0d","firstname":"john","lastname":"doe","email":"john@doe.com","role":"USER"}'

Authentification par Headers HTTP

curl -X POST "https://sarbacaneapis.com/v1/users/invite"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"teamId":"576244e06cc68528289e0b0d","firstname":"john","lastname":"doe","email":"john@doe.com","role":"USER"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet d'inviter un utilisateur sur votre compte.

Requête HTTP

POST https://sarbacaneapis.com/v1/users/invite

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
firstname oui Prénom de l'utilisateur
lastname oui Nom de l'utilisateur
email oui Email de l'utilisateur
role oui Rôle de l'utilisateur, valeurs possibles : "USER" ou "ADMIN"
teamId non Id du groupe attribué à l'utilisateur (uniquement si le rôle est "USER")

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Supprimer utilisateurs et invitations

Authentification HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/users"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"invitations":["john@doe.com"],"userIds":["9cee994b1836fe00018126b4"]}'

Authentification par Headers HTTP

curl -X DELETE "https://sarbacaneapis.com/v1/users"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"invitations":["john@doe.com"],"userIds":["9cee994b1836fe00018126b4"]}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de supprimer des utilisateurs et des invitations à votre compte.

Requête HTTP

DELETE https://sarbacaneapis.com/v1/users

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres de Body

Paramètre Requis Description
invitations non Tableau contenant les emails d'invités à supprimer
userIds non Tableau contenant les ids d'utilisateurs à supprimer

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Modifier un utilisateur

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/users/{userId}/role"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"role":"ADMIN","teamId":"4dee994b1836fe00018126b4"}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/users/{userId}/role"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"role":"ADMIN","teamId":"4dee994b1836fe00018126b4"}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse


Permet de modifier le rôle et le groupe d'un utilisateur.

Requête HTTP

PUT https://sarbacaneapis.com/v1/users/{userId}/role

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
userId oui Id de l'utilisateur

Paramètres de Body

Paramètre Requis Description
role oui Rôle de l'utilisateur, valeurs possibles : "USER" ou "ADMIN"
teamId non Id du groupe attribué à l'utilisateur (uniquement si le rôle est "USER")

Codes erreur

Code HTTP Erreur Description
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 au service, veuillez contacter le support

Récupérer les droits utilisateur

Authentification HTTP

curl -X GET "https://sarbacaneapis.com/v1/users/{userId}/rights"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"

Authentification par Headers HTTP

curl -X GET "https://sarbacaneapis.com/v1/users/{userId}/rights"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{
    "rights": {
        "export_contacts": true,
        "send_campaigns": true,
        "send_tests": true,
        "teams_visibility": true,
        "transfer_templates": true
    }
}

Permet de récupérer la liste des droits d'un utilisateur.

Requête HTTP

GET https://sarbacaneapis.com/v1/users/{userId}/rights

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
userId oui Id de l'utilisateur

Codes erreur

Code HTTP Erreur Description
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 USER_NOT_FOUND L'utilisateur n'existe pas
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support

Modifier les droits utilisateur

Authentification HTTP

curl -X PUT "https://sarbacaneapis.com/v1/users/{userId}/rights"
  -u "YOUR_ACCOUNTID:YOUR_API_KEY"
  -d '{"send_campaigns": true, "export_contacts": true, "teams_visibility": true, "send_tests": true, "transfer_templates": true}'

Authentification par Headers HTTP

curl -X PUT "https://sarbacaneapis.com/v1/users/{userId}/rights"
  -H "accountId: YOUR_ACCOUNTID"
  -H "apiKey: YOUR_API_KEY"
  -d '{"send_campaigns": true, "export_contacts": true, "teams_visibility": true, "send_tests": true, "transfer_templates": true}'

Code réponse HTTP de succès

HTTP/2 200

Body de réponse

{}

Permet de modifier les droits d'un utilisateur.

Requête HTTP

PUT https://sarbacaneapis.com/v1/users/{userId}/rights

Paramètres de Headers

Paramètre Requis Description
accountId oui Id du compte
apiKey oui Clé API

Paramètres d'URL

Paramètre Requis Description
userId oui Id de l'utilisateur

Paramètres de Body

Paramètre Requis Description
send_campaigns non Droit d'envoyer des campagnes
export_contacts non Droit d'exporter les contacts
teams_visibility non Droit de partage de ressources avec d'autres groupes du compte
send_tests non Droit d'effectuer des envois de tests
transfer_templates non Droit de transférer des modèles vers d'autres comptes

Codes erreur

Code HTTP Erreur Description
400 USER_IS_ADMIN Impossible de modifier les droits d'un administrateur
400 INVALID_BODY Body de requête invalide
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 USER_NOT_FOUND L'utilisateur n'existe pas
500 INTERNAL_SERVER_ERROR Erreur interne au service, veuillez contacter le support