EmailAPI (1.0.0)

License: Copyright

email api description.

Liste des erreurs

Voici la liste des codes d'erreur internes, ces erreurs n'apparaissent que dans le cadre d'un statut HTTP 500.

Code Statut HTTP
EMA-1 500
EMA-4 500
EMA-10 500
EMA-13 500
EMA-14 500

Voici la liste des codes d'erreur

Code Description Statut HTTP
EMA-2 Chemin invalide 404
EMA-3 Un paramètre est manquant ou invalide dans le corps de la requête (ex: paramètre envoyé en string au lieu d'un integer) 422
EMA-5 Token manquant 401
EMA-6 Signature du token invalide 400
EMA-7 Token expiré 400
EMA-8 Token invalide 400
EMA-9 Accès non authorisé au service (token invalide) 403
EMA-11 Campagne introuvable 404
EMA-12 Fichier non trouvé 404
EMA-15 Campagne bloquée 403
EMA-16 SMTP non autorisé pour cette campagne 403

Messages

Messages

Envoyer des messages pour une campagne

Envoie un ou plusieurs messages à des destinataires distincts dans le cadre d’une campagne spécifique. Chaque message peut contenir des données personnalisées et des pièces jointes facultatives.

Authorizations:
BearerToken
path Parameters
campaignId
required
integer
Example: 123

Identifiant unique de la campagne

Request Body schema: application/json
required

Liste des messages à envoyer avec leurs destinataires, données personnalisées et pièces jointes (liens).

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "messages": [
    ]
}

Response samples

Content type
application/json
{
  • "campaign_id": 123
}

Met à jour une campagne existante

Met à jour les informations d'une campagne existante avec les données fournies.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 123

ID de la campagne à mettre à jour

Request Body schema: application/json
required

Données à mettre à jour dans la campagne

template
string or null
subject
string or null
label
string or null
sender_email
string or null <email>
sender_name
string or null
reply_to
string or null <email>
callback_url
string or null <uri>
show_unsubscribe_link
boolean or null
operator
string or integer or null

Responses

Request samples

Content type
application/json
{
  • "template": "<html lang=\"\"><body>Hello</body></html>",
  • "subject": "Nouvelle campagne",
  • "label": "Campagne ciss",
  • "sender_email": "sender@example.com",
  • "sender_name": "Sender Name",
  • "reply_to": "reply@example.com",
  • "callback_url": "https://example.com/callback",
  • "show_unsubscribe_link": true,
  • "operator": "operator1"
}

Response samples

Content type
application/json
{ }

Supprime une campagne

Supprime la campagne identifiée par son ID.

Authorizations:
BearerToken
path Parameters
id
required
integer
Example: 123

ID de la campagne à supprimer

Responses

Response samples

Content type
application/json
{
  • "message": "Le bearer token invalide",
  • "code": "EMA-6"
}

Ajoute des fichiers à une campagne

Permet d'ajouter une ou plusieurs pièces jointes à une campagne existante.

Authorizations:
BearerToken
path Parameters
campaignId
required
integer
Example: 123

ID de la campagne à laquelle ajouter les fichiers

Request Body schema: application/json
required

Liste des fichiers à ajouter à la campagne

required
Array of objects

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "campaign_id": 123
}