Eliminar una plantilla

DELETE /api/v1/templates/{templateId}
bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/templates/$TEMPLATE_ID"
Una plantilla usada por una campaña o una secuencia no se puede eliminar. La respuesta es un 409 que nombra lo que la retiene: Template utilisé, suppression impossible — campagnes : « August newsletter ». Reintentar no servirá: desasigna primero la campaña o la secuencia, o conserva la plantilla. Lo que se envió sigue siendo trazable.

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 eliminar

Ejemplo

bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/templates/$TEMPLATE_ID"

Respuesta

  • 200 OK: la llamada se realizó correctamente.
  • 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 lo que se eliminó

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "4d19c0a2"
  }
}

Relacionado