NominexDocs
Referencia de la APICampos PersonalizadosEmpleados

Eliminar

Elimina una definición de campo personalizado.

Descripcion general

Este endpoint realiza el borrado de la definición: a partir de ese momento deja de aparecer en GET /api/v1/employee-custom-fields y se trata como no encontrada en PATCH/DELETE (404). La respuesta exitosa es 204 No Content con cuerpo vacío.

Los valores históricos se conservan. Los valores ya capturados para esta definición no se borran, para mantener consistentes las exportaciones de nómina y reportes previos.

Sin verificación de "valores asignados": el borrado se permite siempre.

Endpoint

DELETEhttps://app.integranom.com/api/v1/employee-custom-fields/{key}

Path param: key — el key actual de la definición. Usa solo minúsculas, números y guiones bajos. Debe iniciar con letra.

Solicitud


Sin cuerpo. La API responde 204 No Content si el borrado tuvo éxito.

Comportamiento

  • Marca la definición como eliminada.
  • La fila deja de devolverse por GET /api/v1/employee-custom-fields.
  • Los valores históricos capturados se conservan.
  • Sin verificación de valores asignados: el borrado siempre se permite.

Errores

StatusCausa
400Formato inválido del key en la URL.
404La definición no existe o ya fue eliminada en esta organización.
Abrir Nominex