Actualizar una plantilla

PATCH /api/v1/templates/{templateId} Actualiza una plantilla. Solo se tocan los campos que envías; los demás se dejan como están. Un content que envías pasa por la misma conversión de etiquetas de combinación, y la respuesta vuelve a llevar unsupportedTags, vacío cuando no tocaste el contenido.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERRechazado — 403
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol sobre AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
templateIdstringObligatorio. La plantilla que se va a modificar

Cuerpo de la solicitud

CampoTipoObligatorioDescripción
namestringnoNuevo nombre
defaultSubjectstringnoNuevo asunto por defecto
contentstringnoNuevo HTML: las etiquetas de Mailchimp se convierten al guardar

Cuerpo de la solicitud

CampoTipoObligatorioDescripción
namestringnoDe 1 a 100 caracteres
defaultSubjectstringnoDe 1 a 200 caracteres
contentstringnoEl HTML del email

Ejemplo

bash
curl -X PATCH -H "x-api-key: $AGENTMAIL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"defaultSubject": "August news"}' \
  "https://www.agentsmail.io/api/v1/templates/$TEMPLATE_ID"

Respuesta

  • 200 OK: la llamada se realizó correctamente.
  • 400 Bad Request: la validación falló; details lleva los problemas por campo.
  • 401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.
  • 403 Forbidden: el propietario de la clave es member de la organización, no admin.
  • 404 Not Found: no existe ese recurso, o pertenece a otra organización. La API nunca confirma que un id existe a un llamante que no tiene derecho sobre él.
  • 429 Too Many Requests: más de 120 solicitudes en un minuto para esta clave.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación se realizó correctamente
data.idstringIdentificador de la plantilla
data.namestringSu nombre
data.defaultSubjectstringAsunto que hereda una campaña, y que puede sobrescribir
data.contentstringEl documento HTML completo
data.createdAt / updatedAtstringFechas ISO
data.unsupportedTagsarrayEtiquetas de Mailchimp que se dejaron intactas en tu HTML: léelo

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "defaultSubject": "August news",
    "content": "<html>…</html>",
    "createdAt` / `updatedAt": "value",
    "unsupportedTags": []
  }
}

Relacionado