Supprimer un champ personnalisé

DELETE /api/v1/custom-fields/{customFieldId} Supprime un champ personnalisé.
Supprimer un champ efface sa valeur sur tous les contacts, dans toutes les listes, d'un coup. Il n'y a pas d'annulation.

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
customFieldIdstringObligatoire. Le champ à supprimer

Exemple

bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/custom-fields/$CUSTOM_FIELD_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 — champ inexistant, ou il appartient à une autre organisation. L'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

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": "4f1a9c2e"
  }
}

Recette pour agent

Retrouver le champ par sa clé, puis le supprimer par son identifiant :
js
const fields = (await list('/api/v1/custom-fields')).data
const field = fields.find((f) => f.key === 'utm_source')

if (field) {
  await del(`/api/v1/custom-fields/${field.id}`)
}

Remarques

  • C'est définitif. Les valeurs disparaissent pour tous les contacts, et recréer un champ avec la même clé repart vide.
  • Une fois le champ supprimé, envoyer sa clé dans les customFields d'un contact est de nouveau refusé.

Voir aussi