*REST API › Endpoint reference › Operations › Tasks*

# Create a task

> Creates a task with domain validation: the type, the staff, the project and the related document are checked against your account, and a foreign reference responds 400 without creating anything.

Returns the created task.

`POST /api/v1/tasks` — scope `tasks:write`

Scope: `tasks:write` · 120/min · Strict tenancy · Idempotency-Key · If-Match · MCP: `filmo_tasks_create`

## Authorizations

Bearer API key with the scope below. `tasks: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. |
| `If-Match` | string | No | Optimistic locking: the `ETag` you read from the resource (or `*`). If the resource changed since, the write is rejected with `412 precondition_failed` before doing anything; read it again and retry. Without the header the write always proceeds. |

## Body

Body schema: `TaskCreateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `title` | string | Yes | Task title. Required. |
| `description` | string | No | Task description or notes. |
| `startDate` | string<date-time> | Yes | Task start date and time (ISO 8601 with offset). Required. |
| `endDate` | string<date-time> | No | Task end date and time (ISO 8601 with offset); must be equal to or later than startDate. |
| `isAllDay` | boolean | No | Whether the task is all-day. Defaults to false. = `false` |
| `type` | string | Yes | Task type: its identifier (system types: default, delivery, return, temporaryStock; custom types: their id, see `/api/v1/task-types`) or its name, matched ignoring case and accents. A name that matches several custom types is rejected with 400 listing their identifiers. The task takes the color of the type. Required. |
| `assignedStaffIds` | string[] | No | Identifiers of the staff assigned to the task (max 50). |
| `projectId` | string | No | Identifier of the project the task is linked to. |
| `relatedDocumentId` | string | No | Identifier of the related document; always goes together with relatedDocumentType. |
| `relatedDocumentType` | string | No | Type of the related document (contact, order, item, invoice, quote, project, etc.); always goes together with relatedDocumentId. `contact`, `order`, `item`, `kit`, `space`, `collection`, `invoice`, `quote`, `purchaseOrder`, `supplierInvoice`, `incident`, `repairTicket`, `project`, `vehicle`, `staff`, `service`, `opportunity` |

## Request examples

*Create a task*

**cURL**

```bash
curl https://app.filmo.io/api/v1/tasks \
  --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 '{
  "title": "Preparar kit de iluminación para rodaje",
  "description": "Revisar baterías y focos antes de la entrega.",
  "startDate": "2026-09-01T09:00:00+02:00",
  "endDate": "2026-09-01T11:00:00+02:00",
  "isAllDay": false,
  "type": "default",
  "assignedStaffIds": [
    "stf_ana",
    "stf_luis"
  ],
  "projectId": "prj_rodaje_otono",
  "relatedDocumentId": "ord_00421",
  "relatedDocumentType": "order"
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/tasks', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    title: 'Preparar kit de iluminación para rodaje',
    description: 'Revisar baterías y focos antes de la entrega.',
    startDate: '2026-09-01T09:00:00+02:00',
    endDate: '2026-09-01T11:00:00+02:00',
    isAllDay: false,
    type: 'default',
    assignedStaffIds: ['stf_ana', 'stf_luis'],
    projectId: 'prj_rodaje_otono',
    relatedDocumentId: 'ord_00421',
    relatedDocumentType: 'order'
  })
})
```

**Python**

```python
import uuid
import requests

requests.post("https://app.filmo.io/api/v1/tasks",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "title": "Preparar kit de iluminación para rodaje",
      "description": "Revisar baterías y focos antes de la entrega.",
      "startDate": "2026-09-01T09:00:00+02:00",
      "endDate": "2026-09-01T11:00:00+02:00",
      "isAllDay": False,
      "type": "default",
      "assignedStaffIds": [
        "stf_ana",
        "stf_luis"
      ],
      "projectId": "prj_rodaje_otono",
      "relatedDocumentId": "ord_00421",
      "relatedDocumentType": "order"
    }
)
```

## Response

Response schema: `TaskDto`

| 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. |
| 412 | Precondition failed (precondition_failed): the `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 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 | The task, as returned by the API. |
| `data.id` | string | Unique task identifier. |
| `data.title` | string | Task title. |
| `data.description` | string | Task description or notes; null if it has none. |
| `data.startDate` | string<date-time> | Start date and time in ISO 8601 with offset. |
| `data.endDate` | string<date-time> | End date and time in ISO 8601 with offset; null if it has no defined end. |
| `data.isAllDay` | boolean | Whether the task is all-day. |
| `data.isCompleted` | boolean | Whether the task is completed. |
| `data.isRecurring` | boolean | Whether the task is part of a recurring series. |
| `data.recurringGroupId` | string | Identifier of the recurrence group it belongs to; null if it is not recurring. |
| `data.recurrencePattern` | object | Recurrence pattern of the task; null if it is not recurring. |
| `data.recurrencePattern.frequency` | string | Recurrence frequency: daily, weekly, monthly or yearly. `daily`, `weekly`, `monthly`, `yearly` |
| `data.recurrencePattern.interval` | integer | Interval between repetitions according to the frequency (e.g. 2 with weekly = every two weeks). |
| `data.recurrencePattern.endAfterOccurrences` | integer | Number of repetitions after which the recurrence ends; null if it does not end by number of occurrences. |
| `data.recurrencePattern.endDate` | string<date-time> | Date on which the recurrence ends, in ISO 8601 with offset; null if it does not end by date. |
| `data.type` | string | Task type (identifier of the type). |
| `data.assignedStaffIds` | string[] | Identifiers of the staff assigned to the task. |
| `data.projectId` | string | Identifier of the linked project; null if the task is not linked. |
| `data.relatedDocumentId` | string | Identifier of the related document; null if it has none. |
| `data.relatedDocumentType` | string | Type of the related document (contact, order, invoice, quote, project, etc.); null if it has none. |
| `data.appearance` | object | Appearance of the task in the schedule (color and variant). |
| `data.appearance.color` | string | Task color in the schedule (hexadecimal code). |
| `data.appearance.variant` | string | Visual variant of the task: primary, secondary, destructive or default. `primary`, `secondary`, `destructive`, `default` |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `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": {
    "id": "task_9f3a2b",
    "title": "Example title",
    "description": "Example text.",
    "startDate": "2026-09-01T08:00:00.000Z",
    "endDate": "2026-09-01T08:00:00.000Z",
    "isAllDay": true,
    "isCompleted": true,
    "isRecurring": true,
    "recurringGroupId": "recurring_group_9f3a2b",
    "recurrencePattern": {
      "frequency": "daily",
      "interval": 1,
      "endAfterOccurrences": 1,
      "endDate": "2026-09-01T08:00:00.000Z"
    },
    "type": "Example type",
    "assignedStaffIds": [
      "assigned_staff_9f3a2b"
    ],
    "projectId": "project_9f3a2b",
    "relatedDocumentId": "related_document_9f3a2b",
    "relatedDocumentType": "Example related document type",
    "appearance": {
      "color": "Example color",
      "variant": "primary"
    },
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}
```

## 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. |
| 412 | `precondition_failed` | The `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 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/tasks/create-a-task  
Last updated: 2026-10-25