Actualizar el identificador externo de un empleado

Este endpoint permite cambiar el identificador externo de un empleado (employeeId).

PUT /api/v1/businesses/{businessId}/employees/{employeeId}/new-employee-id/{newEmployeeId}

Además del identificador externo del negocio (businessId), en la URL se debe especificar el identificador actual del empleado (employeeId) y el nuevo (newEmployeeId). La petición no incluye cuerpo ni parámetros de consulta (query params).

Ejemplo de la petición

PUT /api/v1/businesses/BUSINESSID/employees/CURRENTID/new-employee-id/NEWID

Si la petición se realiza correctamente, la respuesta será 204 No Content.

El employeeId es la clave utilizada para referenciar empleados: tras realizar este cambio, las integraciones deben utilizar el nuevo employeeId.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

404 Not Found

Person <employeeId> does not exist

El employeeId actual indicado no existe en el negocio (el literal interpola el identificador enviado).

409 Conflict

Employee <newEmployeeId> already exists in business <businessId>

El newEmployeeId indicado ya está en uso en el negocio (el literal interpola ambos identificadores).

Enlaces de interés

¿Qué es un empleado?