Enviar correo electrónico¶

Url `POST`¶

/utilities/mail/send

Headers¶

Content-Type: application/json
Accept: application/json
Authotization: Bearer token

Parameters¶

personalizations *:

Type: array object

Cada objeto dentro de las personalizaciones puede considerarse como un correo.

custom_args *:

Type: object

Objeto con datos para el seguimiento de los correos electrónicos

message_uuid *:

Type: string

CUFE O CUDE del documento electrónico.

environment *:

Type: string

El entorno debe ir según sea el caso «1» para producción y «2» para pruebas.

to *:

Type: array object

Cada objeto dentro de esta matriz puede contener el nombre, pero siempre debe contener el correo electrónico de un destinatario.

email *:

Type: string

Correo de destinatario.

name:

Type: string

Correo de destinatario.

dynamic_template_data *:

Type: object

Objeto para modificar la plantilla del correo electrónico.

subject *:

Type: object

Asunto del correo.

header *:

Type: object

Cabecera de la plantilla.

brand_name *:

Type: string

Marca de la compañía.

body *:

Type: object

Cuerpo de la plantilla.

customer_name *:

«Granada»,

Type: string

Nombre del cliente.

document_type *:

Type: string

Tipo de documento.

document_number *:

Type: string

Número del documento.

alternative_text:

Type: string

Texto alternativo.

uuid *:

Type: string

CUFE O CUDE del documento electrónico.

footer *:

Type: object

Pie de la plantilla.

year *:

Type: string

Año.

brand_name *:

Type: string

Marca de la compañía.

address *:

Type: string

Dirección o información extra.

telephone *:

Type: string

Teléfono o información extra.

from *:

Type: object

Datos del remitente.

email *:

Type: string

Default: facturae@midocumentoelectronico.com

Correo electrónico.

name:

Type: string

El nombre de la persona o empresa.

email_to_notify *:

Type: array object

Cada objeto dentro del arreglo corresponde a la empresa o persona interesada en ser notificada del estado de aceptación de los documentos electrónicos.

name *:

Type: string

Nombre de la persona o empresa.

email *:

Type: string

Correo electrónico.

attachments:

Type: array object

Cada objeto del arreglo se considera como un archivo adjunto al correo.

content *:

Type: string

Documento en base64.

mime *:

Type: string

mime del documento que se enviará. Ej: «text/xml»,

filename *:

Type: string

Nombre del documento que se enviara al cliente.

Maqueta del diseño que tendría el correo y la ubicación de sus respectivas variables.

Body¶

{
  "personalizations": [
    {
      "custom_args":
      {
        "message_uuid": "UUID",
        "environment": "1 o 2"
      },
      "to": [
        {
          "email": "adquiriente@adquiriente.co",
          "name": "Adquiriente"
        }
      ],
      "dynamic_template_data":
      {
        "subject": "Asunto del correo",
        "header":
        {
          "brand_name": "Oferente S.A.S."
        },
        "body":
        {
          "customer_name": "Adquiriente S.A.S",
          "document_type": "Factura electrónica de venta",
          "document_number": "FE123",
          "alternative_text": "Texto alternativo",
          "uuid": "código CUFE/CUDE"
        },
        "footer":
        {
          "year": "2020",
          "brand_name": "Oferente S.A.S.",
          "address": "Cra 64 A 23 - 30",
          "telephone": "303-20-21"
        }
      }
    }
  ],
  "from": {
    "email": "noreply@oferente.com",
    "name": "Oferente S.A.S."
  },
  "email_to_notify":
  [
    {
      "name": "notificaciones oferente",
      "email": "notify@oferente.com"
    }
  ],
  "attachments":[
    {
      "content": "Attached Document en base64",
      "mime": "text/xml",
      "filename": "AttachedDocument"
    }
  ]
}

Responses¶

Response `202` OK¶

Si el correo se envió correctamente.

{
  "status": 202,                               // Estado de la solicitud.
  "message": "Correo enviado exitosamente",    // Descripción del estado.
  "message_id": "3PCDZK9tT9C5XT0DxqhEvQ",      // Identificador del correo para hacer la consulta de eventos.
  "date": "2020-02-19 16:12:01"                // Fecha y hora de la solicitud.
}

Response `422` Unprocessable Entity (WebDAV)¶

Si el correo no supera las validaciones.

{
  "errors": [
    {
      "message": "Additional property mime is not allowed.",
      "field": "attachments.0.mime",
      "help": null
    },
    {
      "message": "Invalid type. Expected: object, given: array.",
      "field": "from",
      "help": "http://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/errors.html#message.from"
    }
  ]
}