Saltar al contenido principal

API de correo

Para enviar emails a través de Quentn tienes que seguir estos pasos:

  • Crear email (opcional con marcadores de posición) y recibir un email_id
  • Asegúrate de tener al menos un contacto como destinatario (usa Contact API para crear o recuperar un contacto existente)
  • Obtener un sender_id (opcional)
  • Enviar correo electrónico

Crear correo electrónico

Marcadores de posición

Puedes utilizar cualquier marcador de posición existente ofrecido por el software Quentn (normalmente empieza por [contact:.]). Para obtener una lista completa de todos los marcadores de posición, consulta el editor de email en Quentn. 

Además, Mail-API te permite definir tus propios marcadores de posición para los campos asunto y cuerpo o body. Al enviar correo electrónico a través de la API, puede definir los datos de sustitución correspondientes para cada destinatario. Los marcadores de posición pueden contener cualquier carácter UTF-8, por ejemplo %name% o [first_name]. 

Parámetros de solicitud

Nombre Tipo Obligatorio Descripción
subject String(255) yes Asunto del correo electrónico
body_html String yes Html del correo electrónico
body_text String no Versión de texto sin formato del correo electrónico. Si no se define, se creará automáticamente una versión de texto a partir del body_html dado.
context String(32) yes Contexto del correo electrónico. Por ejemplo, "Inscripción" o "Recordatorio de seminario web".
sender_id Int no El remitente predeterminado que se utilizará para este correo electrónico

Petición:

POST https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/add HTTP/1.1


  {
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Respuesta:


  {
    "id" : 1
  {

 

Recuperar email

After creating an email, you could make sure that everything was done as intended. To do so get the email by its id which you received during creation.

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1

Respuesta:


  {
   "id" : 1,
   "sender_id" : 1,
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Parámetros de la solicitud

 

Actualizar email

Parámetros de la solicitud:

Nombre Tipo Obligatorio Descripción
subject String(255) no Email subject
body_html String no Email Html
body_text String no Versión de texto sin formato del correo electrónico. Si no se define, se creará automáticamente una versión de texto a partir del body_html dado.
context String(32) no Contexto del correo electrónico. Por ejemplo, "Inscripción" o "Recordatorio de seminario web".
sender_id Int no El remitente predeterminado que se utilizará para este correo electrónico

Petición:

PUT https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1


  {
   "sender_id" : 1,
   "subject" : "Welcome to my Newsletter",
   "body_html" : "<html><body><h1>Hello @name@, welcome to my Newsletter</h1>...",
   "body_text" : "Hello @name@, welcome to my Newsletter",
   "context" : "opt_in_mail"
  }

Respuesta:


{
  "success": "true",
}

 

Borrar Email

Petición:

DELETE https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id> HTTP/1.1

Respuesta:


{
  "success": "true",
}

 

Obtener IDs de remitente

Recupera una lista de remitentes disponibles. Ten en cuenta que sólo recibirás remitentes confirmados. 

Parámetros de respuesta

Nombre Tipo Siempre incluido Descripción
id int yes Sender ID
email String yes Sender email address
first_name String no First name
last_name String no Last name
company Int no Company

Petición:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/senders HTTP/1.1

Respuesta:


 [
   {
     "id" : 1,
     "email" : "johndoe@example.de",
     "first_name" : "John",
     "last_name" : "Doe",   
     "company" : "John Doe's Bikeshop Ltd."
   },
   {
     "id" : 2,
     "email" : "bikeshop@example.com"
   }
]

 

Enviar email

Para enviar un email , debes proporcionar un ID de correo electrónico y una lista de destinatarios. Esta lista contiene un ID de contacto y, opcionalmente, datos de sustitución para marcadores de posición de correo electrónico.

Nota: Cada solicitud tiene un límite de 1.000 destinatarios.

Valores de solicitud:

Nombre Tipo Obligatorio Descripción
email_id int yes Email ID
recipients array yes Lista de destinatarios que contiene el Id. del destinatario y una lista opcional de sustituciones de campos (véase el ejemplo a continuación)
sender_id int no Id. del remitente

Petición:

POST https://<system_id>.<server_id>.quentn.com/public/api/V1/mail/<email_id>/send HTTP/1.1

Datos de la solicitud:


{
   'email_id' : 123,
   'recipients' : [
        {
           'id' : 1,
           'substitution_data' : {
                "@name@" : "John",
                 ....
            }
         },
         .....
    ]
}

Respuesta:


{
  "success": "true",
}

Artículos relacionados