Skip to content

GET /mailing/email-request/{uuid} ​

Récupérez le statut de base et les détails d'une demande d'envoi.

Vue d'ensemble ​

Utilisez cet endpoint pour inspecter la demande d'envoi d'origine une fois créée.
Il renvoie l'objet email_request, qui représente la demande de base et les informations traitées sur ses destinataires.

Endpoint ​

http
GET /mailing/email-request/{uuid}

Paramètres de chemin ​

ParamètreTypeRequisDescription
uuidstringOuiUUID de la demande d'envoi.

Exemple de requête ​

bash
curl -X GET https://api.mailiqo.com/v1/mailing/email-request/2b687f6a-7e85-4c14-8b17-xxxxxxx \
  -H "X-API-KEY: YOUR_API_KEY"

Structure de la réponse ​

La réponse est enveloppée dans {status, data}, et data contient l'objet email_request.
⚠️ Cet endpoint renvoie l'objet au niveau de la demande, pas l'enregistrement d'un email livré individuellement. La différence est que l'objet email_request contient les informations de la demande d'origine, tandis que l'objet email_message représente le message traité envoyé à un seul destinataire. Chaque email_request peut générer plusieurs enregistrements email_message s'il y a plusieurs destinataires.

Champs de email_request ​

ChampTypeDescription
uuidstringUUID de la demande d'envoi.
statusstringStatut actuel de la demande
total_recipientsintegerNombre total de destinataires de la demande.
domainstringDomaine d'envoi.
from_emailstringAdresse email de l'expéditeur d'origine.
subjectstringObjet d'origine de l'email.
email_messagesarrayListe des UUID des messages générés à partir de cette demande.
total_attachmentsintegerNombre total de pièces jointes de la demande.
recipientsobjectObjet contenant les informations d'origine et traitées des destinataires.
created_atobjectHorodatage de la création de la demande.

Champs de recipients ​

ChampTypeDescription
toarrayDestinataires to d'origine.
ccarrayDestinataires cc d'origine.
bccarrayDestinataires bcc d'origine.

Exemple de réponse ​

json
{
  "status": "success",
  "data": {
    "email_request": {
      "uuid": "2b687f6a-7e85-4c14-8b17-xxxxxxx",
      "status": "QUEUED",
      "total_recipients": 1,
      "domain": "votredomaine.com",
      "from_email": "[email protected]",
      "subject": "Bonjour de Mailiqo",
      "email_messages": [
        "c82929b4-8c6e-45f0-b048-xxxxxxxxx"
      ],
      "total_attachments": 0,
      "recipients": {
        "to": [
          {
            "email": "[email protected]",
            "name": ""
          }
        ],
        "cc": [],
        "bcc": []
      },
      "created_at": {
        "date": "2026-03-20 10:29:05.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  }
}

Réponses HTTP ​

StatutSignification
200Demande d'envoi trouvée et renvoyée.
404Demande d'envoi introuvable.
500Erreur interne du serveur.

Format de la réponse d'erreur ​

json
{
  "status": "error",
  "error": {
    "code": "9999",
    "message": "Error message describing the issue."
  }
}

Remarques ​

  • Cet endpoint renvoie l'objet au niveau de la demande, pas l'enregistrement d'un email livré individuellement. La différence est que l'objet email_request contient les informations de la demande d'origine, tandis que l'objet email_message représente le message traité envoyé à un seul destinataire. Chaque email_request peut générer plusieurs enregistrements email_message s'il y a plusieurs destinataires.
  • Utilisez cet endpoint quand vous devez inspecter les destinataires traités ou les métadonnées de la demande.
  • Pour inspecter un message précis, utilisez GET /mailing/email-message/{uuid}.

Endpoints associés ​

  • POST /v1/mailing/send
  • GET /v1/mailing/email-message/{uuid}

Built with VitePress