DELETE /api/v1/custom-fields/{customFieldId}
Elimina un campo personalizado.
Eliminar un campo borra su valor en todos los contactos, en todas las listas, de una vez. No se puede deshacer.
Autorización
| Rol en la organización | Este endpoint |
|---|---|
OWNER | Permitido |
ADMIN | Permitido |
MEMBER | Rechazado — 403 |
Parámetros de ruta
| Parámetro | Tipo | Descripción |
|---|---|---|
customFieldId | string | Obligatorio. El campo que se elimina |
Ejemplo
bash
curl -X DELETE -H "x-api-key: $AGENTMAIL_API_KEY" \
"https://www.agentsmail.io/api/v1/custom-fields/$CUSTOM_FIELD_ID"Respuesta
200 OK: el id de lo que se eliminó.401 Unauthorized: clave ausente o no válida, o su propietario salió de la organización.403 Forbidden: el propietario de la clave esmemberde la organización, noadmin.404 Not Found: no existe ese campo, 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
| Campo | Tipo | Descripción |
|---|---|---|
success | boolean | Indica si la operación tuvo éxito |
data.id | string | Identificador de lo que se eliminó |
Ejemplo de respuesta
json
{
"success": true,
"data": {
"id": "4f1a9c2e"
}
}Receta para agentes
Encuentra el campo por su clave y luego elimínalo por su id: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}`)
}Notas
- Es definitivo. Los valores desaparecen para todos los contactos, y crear un campo con la misma clave después empieza vacío.
- Una vez eliminado el campo, enviar su clave en los
customFieldsde un contacto vuelve a rechazarse.