Skip to main content
POST
Add a task about a contact

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Path Parameters

id
string<uuid>
required

Public id of one of the member's contacts.

Body

application/json

A new task about the contact named by the path.

title
string
required

What to do.

Required string length: 1 - 10000
Pattern: \S
notes
string | null

Optional detail; null leaves it empty.

Maximum string length: 10000
due_at
string<date-time> | null

Due time; null for none.

priority
enum<string>

Priority; normal unless set.

Available options:
low,
normal,
high

Response

The new task.

One task.

status
integer
required
data
object
required

A member's to-do, optionally about one of their contacts.

meta
object
required

Envelope metadata present on every response.