*REST API › Endpoint reference › Catalog & inventory › Availability*

# Declare an unavailability

> Declares that a resource is not available in a window: holidays, a maintenance, a closure.

`reason` is ACCEPTED and not returned: it stays in Filmo for whoever has access. For a person or a vehicle, overlapping commitments do not block: the unavailability is recorded and `warningCount` says how many already reserved commitments overlap with it. A space is different: declaring it `unavailable` in a window where it is booked responds 409 `conflict` and nothing is written, so on a space `warningCount` is always 0. It also responds 409 if an identical unavailability already exists (same resource, window, state, type and reason). It responds 400 `validation_error`, with `errors[0].path` on the field, when `endDate` is not after `startDate`, when `resourceId` does not exist or belongs to another account, and when `absenceType` is not one of its resource type: `vacation`, `sick`, `personal`, `training` or `other` for staff; `maintenance`, `inspection`, `repair`, `reserved` or `other` for vehicles; `academic`, `maintenance`, `event`, `closure` or `other` for spaces. On a space it responds 503 `service_unavailable` while space unavailabilities are switched off for the account.

`POST /api/v1/availability/unavailabilities` — scope `availability:write`

Scope: `availability:write` · 120/min · Idempotency-Key · MCP: `filmo_unavailabilities_create`

## Authorizations

Bearer API key with the scope below. `availability:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |

## Body

Body schema: `UnavailabilityCreateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `resourceType` | string | Yes | Which resource is declared unavailable. `staff`, `vehicle`, `space` |
| `resourceId` | string | Yes | Identifier of that resource. |
| `startDate` | string<date-time> | Yes | Start, in ISO 8601 with offset. |
| `endDate` | string<date-time> | Yes | End, in ISO 8601 with offset. |
| `state` | string | Yes | What is declared for that window. `available`, `unavailable`, `unknown` |
| `absenceType` | string | No | Absence type. `vacation`, `sick`, `personal`, `training`, `maintenance`, `inspection`, `repair`, `reserved`, `academic`, `event`, `closure`, `other` |
| `reason` | string | No | Reason. Stored in Filmo and NOT returned by the API. |

## Request examples

*Declare an unavailability*

**cURL**

```bash
curl https://app.filmo.io/api/v1/availability/unavailabilities \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "resourceType": "staff",
  "resourceId": "stf_ana",
  "startDate": "2026-08-01T00:00:00+02:00",
  "endDate": "2026-08-15T23:59:59+02:00",
  "state": "unavailable",
  "absenceType": "vacation"
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/availability/unavailabilities', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    resourceType: 'staff',
    resourceId: 'stf_ana',
    startDate: '2026-08-01T00:00:00+02:00',
    endDate: '2026-08-15T23:59:59+02:00',
    state: 'unavailable',
    absenceType: 'vacation'
  })
})
```

**Python**

```python
import uuid
import requests

requests.post(
    "https://app.filmo.io/api/v1/availability/unavailabilities",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "resourceType": "staff",
      "resourceId": "stf_ana",
      "startDate": "2026-08-01T00:00:00+02:00",
      "endDate": "2026-08-15T23:59:59+02:00",
      "state": "unavailable",
      "absenceType": "vacation"
    }
)
```

## Response

Response schema: `UnavailabilityResultDto`

| Status | Description |
| --- | --- |
| 201 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |
| 503 | Service unavailable (service_unavailable): the feature this operation writes to is switched off for the account. The request is correct; it works again once the feature is switched on. |

**201**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Result of declaring or updating an unavailability. |
| `data.availability` | object | The unavailability as it now stands. |
| `data.availability.id` | string | Unique identifier of the unavailability. |
| `data.availability.resourceType` | string | Which resource: staff, vehicle or space. |
| `data.availability.resourceId` | string | Identifier of that resource. |
| `data.availability.resourceName` | string | Resource name; null if not recorded. |
| `data.availability.startDate` | string<date-time> | Start of the unavailability in ISO 8601 UTC. |
| `data.availability.endDate` | string<date-time> | End of the unavailability in ISO 8601 UTC. |
| `data.availability.state` | string | Declared state. This list only returns `unavailable` windows that have not ended yet, so it is always `unavailable` here; `available` and `unknown` exist as declarations but are not listed. |
| `data.availability.absenceType` | string | Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null. |
| `data.availability.updatedAt` | string<date-time> | Last modification in ISO 8601 UTC; null if not recorded. |
| `data.warningCount` | integer | Commitments of the resource that overlap this unavailability. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 201*

```json
{
  "data": {
    "availability": {
      "id": "availability_9f3a2b",
      "resourceType": "Example resource type",
      "resourceId": "resource_9f3a2b",
      "resourceName": "Example resource name",
      "startDate": "2026-09-01T08:00:00.000Z",
      "endDate": "2026-09-01T08:00:00.000Z",
      "state": "Madrid",
      "absenceType": "Example absence type",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    },
    "warningCount": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |
| 503 | `service_unavailable` | The feature this operation writes to is switched off for the account. The request is correct; it works again once the feature is switched on. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/availability/declare-an-unavailability  
Last updated: 2026-10-25