*REST API › Endpoint reference › Operations › Planner*

# Assign a resource to a service

> Puts a person or a vehicle on a service.

The target is EXACTLY one: the pair `orderId` + `orderServiceId`, or a task, or an internal service. The resource, also exactly one. `conflictCount` says how many commitments of the resource overlap with this assignment: the assignment is made anyway, and you decide what to do with the number. It responds 400 `validation_error`, with `errors[].path` on the field, when `staffId`, `vehicleId` or the target (`orderServiceId`, `taskId`, `internalServiceId`) does not exist or belongs to another account, when the target does not accept that type of resource (a task only accepts staff; a service, the resource types its requirements declare) and when the task does not block availability; 409 `conflict` when the resource is already assigned to that target or is unavailable in that period. Nothing is written in any of those cases.

`POST /api/v1/planner/assignments` — scope `planner:write`

Scope: `planner:write` · 120/min · Idempotency-Key · MCP: `filmo_planner_assignment_create`

## Authorizations

Bearer API key with the scope below. `planner: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: `PlannerAssignmentCreateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `orderId` | string | No | Order the service is attached to. |
| `orderServiceId` | string | No | Service line within that order. Goes with `orderId`. |
| `taskId` | string | No | Schedule task to assign the resource to. |
| `internalServiceId` | string | No | Internal assignment to cover. |
| `staffId` | string | No | Staff member being assigned. |
| `vehicleId` | string | No | Vehicle being assigned. |
| `role` | string | No | Role they are assigned with. E.g.: "Conductor". |

## Request examples

*Assign a resource to a service*

**cURL**

```bash
curl https://app.filmo.io/api/v1/planner/assignments \
  --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 '{
  "orderId": "ord_0000421",
  "orderServiceId": "osv_0000912",
  "staffId": "stf_luis_perez",
  "role": "Conductor"
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/planner/assignments', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    orderId: 'ord_0000421',
    orderServiceId: 'osv_0000912',
    staffId: 'stf_luis_perez',
    role: 'Conductor'
  })
})
```

**Python**

```python
import uuid
import requests

requests.post(
    "https://app.filmo.io/api/v1/planner/assignments",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "orderId": "ord_0000421",
      "orderServiceId": "osv_0000912",
      "staffId": "stf_luis_perez",
      "role": "Conductor"
    }
)
```

## Response

Response schema: `PlannerAssignResultDto`

| 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). |

**201**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Result of assigning a resource. |
| `data.status` | string | Operation result. |
| `data.conflictCount` | number | Commitments of the resource that overlap with this assignment. |
| `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": {
    "status": "Example status",
    "conflictCount": 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. |

## 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/planner/assign-a-resource-to-a-service  
Last updated: 2026-10-25