Work Schedules

Assign a schedule to an employee

Assign the work schedule to an employee with an effective start date; the previous open assignment is closed and history is kept.

  • employee_id and effective_from (Y-m-d) are required.
  • An unknown employee returns 422 assigned_employee_not_found; moving back the start of an assignment already in effect returns 422.
  • Returns the created assignment.
post/companies/{company}/work-schedules/{schedule}/assign

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/work-schedules/{schedule}/assign
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

schedulestring uuid required

Public identifier (UUID v7) of the work schedule.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

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 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

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.

Request body

employee_idstring uuid required

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

effective_fromstring date required

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

Response

Example response

{
  "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",
    "created_at": "2024-09-02T08:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.