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.

../../_images/plantilla_correo.png

Body

 1{
 2  "personalizations": [
 3        {
 4          "custom_args":
 5          {
 6                "message_uuid": "UUID",
 7                "environment": "1 o 2"
 8          },
 9          "to": [
10                {
11                  "email": "adquiriente@adquiriente.co",
12                  "name": "Adquiriente"
13                }
14          ],
15          "dynamic_template_data":
16          {
17                "subject": "Asunto del correo",
18                "header":
19                {
20                  "brand_name": "Oferente S.A.S."
21                },
22                "body":
23                {
24                  "customer_name": "Adquiriente S.A.S",
25                  "document_type": "Factura electrónica de venta",
26                  "document_number": "FE123",
27                  "alternative_text": "Texto alternativo",
28                  "uuid": "código CUFE/CUDE"
29                },
30                "footer":
31                {
32                  "year": "2020",
33                  "brand_name": "Oferente S.A.S.",
34                  "address": "Cra 64 A 23 - 30",
35                  "telephone": "303-20-21"
36                }
37          }
38        }
39  ],
40  "from": {
41        "email": "noreply@oferente.com",
42        "name": "Oferente S.A.S."
43  },
44  "email_to_notify":
45    [
46      {
47        "name": "notificaciones oferente",
48        "email": "notify@oferente.com"
49          }
50   ],
51  "attachments":[
52        {
53          "content": "Attached Document en base64",
54          "mime": "text/xml",
55          "filename": "AttachedDocument"
56        }
57  ]
58}

Responses

Response 202 OK

Si el correo se envió correctamente.

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

Response 422 Unprocessable Entity (WebDAV)

Si el correo no supera las validaciones.

 1{
 2  "errors": [
 3        {
 4          "message": "Additional property mime is not allowed.",
 5          "field": "attachments.0.mime",
 6          "help": null
 7        },
 8        {
 9          "message": "Invalid type. Expected: object, given: array.",
10          "field": "from",
11          "help": "http://sendgrid.com/docs/API_Reference/Web_API_v3/Mail/errors.html#message.from"
12        }
13  ]
14}