Listar plantillas

Supervisor
Supervisor
  • Actualización

Nombre del servicio

GET https://api.envialosimple.email/api/v1/templates

Método de autenticación

Authorization: Bearer <clave API>

Para más detalle sobre cómo generar clave API ver: Cómo enviar mails desde la API

Descripción

Devuelve una lista con todas las plantillas disponibles.

Parámetros

Nombre Tipo Descripción
page Integer Número de página. Por defecto: 1.
limit Integer Cantidad de registros por página. Por defecto: 10. Máximo: 100.
sort string Ordenar por. Valores posibles: name/created_date/lastsend_date. Por defecto: created_date
direction string Tipo de ordenamiento. Valores posibles: asc/desc. Por defecto: desc.
filters string Expresión para filtrar los registros. Ver detalle de la Generación de expresiones (*).

Respuesta

Campo Descripción
id ID de plantilla.
created_date Fecha de creación. Zona horaria UTC+00:00.
updated_date Fecha de modificación. Zona horaria UTC+00:00.
preview URL de la vista previa.
name Nombre de la plantilla.
tags

Etiquetas de la plantilla.

Valores posibles:

authentication ➔ Autenticación

confirmation ➔ Confirmación

feedback ➔ Feedback

notification ➔ Notificación

others ➔ Otros

register ➔ Registro

lastsend_date Fecha de último envío. Zona horaria UTC+00:00.

Ejemplos de respuesta

{

    "page": 1,

    "limit": 2,

    "payload": [

        {

            "id": "650d935447bfb73c8d03cd88",

            "created_date": "2023-09-22T13:15:00+00:00",

            "updated_date": "2024-01-09T18:24:59+00:00",

            "name": "prueba1",

           "preview":"/files/Templates/6452a270807877b0d506e2a5/      

             template_650d935447bfb73c8d03cd88.png",

            "tags": [

                "others"

            ],

            "lastsend_date": null

        },

        {

            "id": "64c40fec87819d9a480428c2",

            "created_date": "2023-07-28T18:58:52+00:00",

            "updated_date": "2023-07-28T19:44:59+00:00",

            "name": "prueba2",

            "preview":"/files/Templates/6452a270807877b0d326e2a5/

                                 template_64c40fec87819d9a480428c2.png",

            "tags": [],

            "lastsend_date": "2023-07-28T19:44:59+00:00"

        }

    ],

    "total": 21

}

Generación de expresiones (*).

La sintaxis es similar a la utilizada por MongoDB, con la diferencia que solo algunas de las operaciones están soportadas.

  • Filtro por un valor exacto:
    Para buscar por coincidencia de un valor exacto deberá utilizarse la siguiente sintaxis: {"nombre del campo": "valor del campo"}.
    Ejemplo: {"name": "prueba"}. Esta búsqueda traerá todos los registros cuyo campo nombre sea exactamente igual a “prueba”
  • Filtro con operador:
    Para buscar utilizando un operador deberá utilizarse la siguiente sintaxis: {"nombre del campo": {“operador": "valor del campo"}}
    Ejemplo: {"name":{"$regex":"prueba"}}. Esta búsqueda traerá todos los registros cuyo campo nombre contenga “prueba”.

    Los operadores de comparación soportados son:

    Operador Descripción
    $eq Igual
    $neq Distinto
    $gt Mayor
    $gte: Mayor o Igual
    $lt Menor
    $lte: Menor o Igual
    $in: Es igual a alguno los valores indicados
    $nin: No es igual a ninguno los valores indicados
    $regex: Expresión regular
  • Filtro usando casting de variable
    Para buscar haciendo casting de una variable fecha deberá utilizarse el operador $ts: Timestamp el cual convierte el valor de fecha en timestamp para luego poder utilizar los operadores disponibles.
    Ejemplo: {"date":{"$gt":{"$ts":1704974124}}}. Esta búsqueda traerá todos los registros con fecha mayor a la fecha indicada en el timestamp

  • Filtro usando expresiones combinadas
    Para buscar combinando varias expresiones deberá utilizarse la siguiente sintaxis: {"operador lógico": [expresión1, expresión 2]}.
    Ejemplo: {"$or": [{"lastsend_date": {"$eq": null}}, {"name": "prueba"}]}. Esta búsqueda traerá todos los registros que tengan fecha de último envío null más los que tengan nombre = prueba..


    Los operadores lógicos soportados son:

    Operador Descripción
    $and: Operador lógico AND
    $or: Operador lógico OR
    $nor: Operador lógico OR negado

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0

¿Tiene más preguntas? Enviar una solicitud

Comentarios

0 comentarios

El artículo está cerrado para comentarios.