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'organisation | Cet endpoint |
|---|---|
OWNER | Autorisé |
ADMIN | Autorisé |
MEMBER | Refusé — 403 |
Paramètres de chemin
| Paramètre | Type | Description |
|---|---|---|
customFieldId | string | Obligatoire. 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é estmemberde l'organisation, pasadmin.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
| Champ | Type | Description |
|---|---|---|
success | boolean | Indique si l'opération a réussi |
data.id | string | Identifiant 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
customFieldsd'un contact est de nouveau refusé.