Supprimer une page d'inscription

DELETE /api/v1/signup-pages/{id} Supprime une page d'inscription. Son adresse publique cesse de répondre sur-le-champ.
Il n'y a pas d'annulation, et l'adresse n'est pas réservée. La suppression libère le slug : tout lien que vous avez publié vers elle est mort, et une nouvelle page pourrait reprendre la même adresse plus tard. Passez plutôt status à draft si vous voulez seulement retirer la page du web.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERRefusé — 403
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Paramètres de chemin

ParamètreTypeDescription
idstringObligatoire. La page à supprimer

Exemple

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

Réponse

  • 200 OK — l'identifiant de ce qui a été supprimé.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 403 Forbidden — le propriétaire de la clé est member de l'organisation, pas admin.
  • 404 Not Found — aucune page de ce type, ou elle appartient à une autre organisation. Rien n'a été supprimé, et l'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
  • 429 Too Many Requests — la clé a dépassé sa limite de débit.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.idstringIdentifiant de ce qui a été supprimé

Exemple de réponse

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

Recette pour agent

Retirez d'abord la page du web, regardez ce qu'elle alimentait, et seulement ensuite supprimez — une dépublication est réversible, cet appel ne l'est pas :
js
await patch(`/api/v1/signup-pages/${pageId}`, {status: 'draft'})

const page = (await get(`/api/v1/signup-pages/${pageId}`)).data
// page.listId keeps the subscribers: nothing here removes a contact

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

Remarques

  • Les contacts restent. Ils appartiennent à la liste, pas à la page qui les a collectés, et ils conservent leur propre lien de désabonnement.
  • Supprimer une page qui était déjà un brouillon ne change rien de visible pour personne : elle répondait déjà par une page introuvable.

Voir aussi