Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Headers

Idempotency-Key
string

Optional key that makes a retry of this operation safe. Send a new value, 1 to 255 printable ASCII characters, for each intended operation, and send the same value with the same request when you retry it. A committed attempt reserves the key for 30 days from admission; retries do not extend that window. After 30 days the same key runs as a new request, even if its body differs. Within that window, a retry after the first request completed returns the original resource or run identity with the same status and response shape, without starting another operation. A failure before the intent commits stores nothing; after an external effect fails, a retry may resume that same committed intent. Keys belong to the credential, so another API key, even one the same user created, cannot replay them. Within 30 days, reusing a key with a different request returns 422 IDEMPOTENCY_KEY_REUSED; an invalid key returns 400 INVALID_IDEMPOTENCY_KEY. The key is compared exactly, so case and surrounding spaces count.

Required string length: 1 - 255
Pattern: ^[\x20-\x7E]{1,255}$

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json
name
string
required

Task name

deadline
string<date-time>
required

Task deadline as an ISO 8601 date-time string

description
string
default:""

Task description (defaults to an empty string)

status
enum<string>
default:Not Complete

Task completion status (defaults to Not Complete)

Available options:
Not Complete,
Complete
entity
object

Entity to link the task to (e.g. a claim or policy)

assignees
string[]

Company user IDs to assign the task to: member ids from List Company Members.

Response

Task created successfully

id
string<uuid>

The ID of the created task