Work Schedules

Unassign a schedule from an employee

Close the employee's open assignment to this schedule; employee_id is required and effective_to (Y-m-d) defaults to today.

  • An assignment not yet started is cancelled and kept in history as an empty span.
  • Closing an assignment in effect before its start returns 422; no open assignment returns 404. Responds 204.
post/companies/{company}/work-schedules/{schedule}/unassign

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/work-schedules/{schedule}/unassign
  • 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) whose assignment is removed.

effective_tostring date nullable

Assignment effective end date (Y-m-d); defaults to today when omitted.

Response

No content

Changes

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