Eliminar una página de suscripción

DELETE /api/v1/signup-pages/{id} Elimina una página de suscripción. Su dirección pública deja de responder de inmediato.
No se puede deshacer, y la dirección no queda reservada. Eliminar libera el slug: cualquier enlace que hayas publicado hacia él queda muerto, y una página nueva podría tomar la misma dirección más adelante. Pon status en draft si solo quieres retirar la página.

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 en AgentsMail en sí. Consulta Claves de API.

Parámetros de ruta

ParámetroTipoDescripción
idstringObligatorio. La página que se elimina

Ejemplo

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

Respuesta

  • 200 OK: el id de lo que se eliminó.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 403 Forbidden: el propietario de la clave es member de la organización, no admin.
  • 404 Not Found: no existe esa página, o pertenece a otra organización. No se eliminó nada, y la API nunca confirma que un id existe a quien no tiene derecho sobre él.
  • 429 Too Many Requests: la clave superó su límite de peticiones.

Campos de la respuesta

CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data.idstringIdentificador de lo que se eliminó

Ejemplo de respuesta

json
{
  "success": true,
  "data": {
    "id": "3d3d3d3d-4444-4eee-9fff-000011112222"
  }
}

Receta para agentes

Retira primero la página, mira qué estaba alimentando y solo entonces elimínala: despublicar es reversible, esta llamada no:
js
await patch(`/api/v1/signup-pages/${pageId}`, {status: 'draft'})

const page = (await get(`/api/v1/signup-pages/${pageId}`)).data
// page.listId conserva a los suscriptores: nada aquí elimina un contacto

await del(`/api/v1/signup-pages/${pageId}`)

Notas

  • Los contactos se quedan. Pertenecen a la lista, no a la página que los recogió, y conservan su propio enlace de baja.
  • Eliminar una página que ya era un borrador no cambia nada visible para nadie: ya respondía con una página de no encontrado.

Relacionado