Availability

Declare an unavailability

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

Tool

filmo_unavailabilities_create

Writeavailability:write

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_unavailabilities_create",
    "arguments": {
      "resourceType": "staff",
      "resourceId": "reso_8f2a1c",
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z",
      "state": "available"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "availability": {
        "id": "id_8f2a1c",
        "resourceType": "<resourceType>",
        "resourceId": "reso_8f2a1c",
        "resourceName": "Example",
        "startDate": "2026-09-01T08:00:00Z",
        "endDate": "2026-09-01T08:00:00Z",
        "state": "<state>",
        "absenceType": "<absenceType>",
        "updatedAt": "2026-09-01T08:00:00Z"
      },
      "warningCount": 1
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

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.

Arguments

resourceTypestringRequired

Which resource is declared unavailable.

Available options: staff, vehicle, space

resourceIdstringRequired

Identifier of that resource.

Limits: min length 1

startDatestring<date-time>Required

Start, in ISO 8601 with offset.

endDatestring<date-time>Required

End, in ISO 8601 with offset.

statestringRequired

What is declared for that window.

Available options: available, unavailable, unknown

absenceTypestring

Absence type.

Available options: vacation, sick, personal, training, maintenance, inspection, repair, reserved, academic, event, closure, other

reasonstring

Reason. Stored in Filmo and NOT returned by the API.

Limits: max length 500

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

availabilityobject

The unavailability as it now stands.

Show child attributes

availability.idstring

Unique identifier of the unavailability.

availability.resourceTypestring

Which resource: staff, vehicle or space.

availability.resourceIdstring

Identifier of that resource.

availability.resourceNamestring | null

Resource name; null if not recorded.

availability.startDatestring<date-time>

Start of the unavailability in ISO 8601 UTC.

availability.endDatestring<date-time>

End of the unavailability in ISO 8601 UTC.

availability.statestring

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.

availability.absenceTypestring | null

Absence type. Only emitted for vehicles and spaces, where it is operational; for staff it is health data and is returned as null.

availability.updatedAtstring<date-time> | null

Last modification in ISO 8601 UTC; null if not recorded.

warningCountinteger

Commitments of the resource that overlap this unavailability.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs POST /api/v1/availability/unavailabilities.

Availability
Declare an unavailability
Declares that a resource is not available in a window: holidays, a maintenance, a closure.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Declare an unavailability

Safe writes

Errors