Assign a schedule to an employee

Assign the work schedule to an employee with an effective start date.

employee_id (UUID v7, must belong to your company) and effective_from (Y-m-d) are required.
Assigning closes the employee’s previously open assignment and opens the new one (an employee has at most one open assignment; history is preserved).
An unknown employee returns 422 assigned_employee_not_found; an unknown schedule returns 404. Returns the created assignment.

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 409 idempotency_key_reused. See the Idempotency guide.

Length1 <= length <= 255

Factuarea-Version?string

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

employee_id*string

Employee ID (UUID v7) the schedule is assigned to.

Formatuuid

effective_from*string

Assignment effective start date, in Y-m-d.

Formatdate

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/work-schedules/01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01/assign", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json","Idempotency-Key":"erp-2026-public-api-v1-work_schedules-assign"} },  body: JSON.stringify({  "employee_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8b01",  "effective_from": "2026-06-01"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f02",
    "object": "work_schedule_assignment",
    "work_schedule_id": "01933a20-9d32-7c4e-8a5b-2b3c4d5e6f01",
    "employee_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "effective_from": "2024-09-02",
    "effective_to": null,
    "created_at": "2024-09-02T08:00:00Z"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_f01643aded7df046d1d58ca6bd"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'work_schedules:write'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_0953e290a958b05786fdd55d00"
  }
}

{
  "error": {
    "type": "not_found_error",
    "code": "work_schedule_not_found",
    "message": "Horario no encontrado.",
    "doc_url": "https://docs.factuarea.com/guides/errors#work_schedule_not_found",
    "request_id": "req_2f503b0592f1451febb6577055"
  }
}

{
  "error": {
    "type": "idempotency_error",
    "code": "idempotency_key_reused",
    "message": "Esa `Idempotency-Key` ya se usó con un payload distinto. La clave identifica una operación concreta, así que reutilizarla para otra vaciaría de sentido el replay.",
    "doc_url": "https://docs.factuarea.com/guides/errors#idempotency_key_reused",
    "request_id": "req_1febbfbc0e25df2926a93d6e33"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo employee_id es obligatorio.",
    "param": "employee_id",
    "errors": [
      {
        "param": "employee_id",
        "code": "parameter_missing",
        "message": "El campo employee_id es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_c0af8d6d560535ef377ee4cdb5"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_4c716cb6fac16c8b2804f0df5e"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_58e24d48540b740cc86df11e02"
  }
}

Assign a schedule to an employee

Authorization

Path Parameters

Headers

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Assign a schedule to an employee

Authorization

Path Parameters

Headers

Request Body

Response Body

201application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`