Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer token: a Platform API Key (format: ak_live::) or a Personal Access Token (format: rgo-...). PATs always act as the token owner.

Body

application/json
title
string
required
Maximum string length: 255
type
enum<string>
required
Available options:
call,
email,
meeting,
follow_up,
todo
dueDate
string
required
sourceRef
string

Where the task came from, e.g. notetaker:<session>:<item>.

Maximum string length: 200
Pattern: /^[a-z]+:[A-Za-z0-9:._-]+$/
description
string
Maximum string length: 10000
priority
enum<string>
Available options:
low,
medium,
high
reminderAt
string
assigneeId
string
assigneeIds
string[]

Everyone the task is offered to. Any of them can take it, which makes them the only assignee. assigneeId, when on the list, is the primary; otherwise the first id is.

contactId
string
dealId
string
crmCompanyId
string

Response

id
string
required
title
string
required
type
enum<string>
required
Available options:
call,
email,
meeting,
follow_up,
todo
priority
enum<string>
required
Available options:
low,
medium,
high
dueDate
string<date-time>
required
completed
boolean
required
assigneeId
string
required

The primary assignee, or whoever took the task.

assigneeIds
string[]
required

Everyone the task is assigned to, primary first.

companyId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string
reminderAt
string<date-time> | null
completedAt
string<date-time>
completedById
string

Who marked the task done; absent on tasks done before this was kept.

contactId
string
dealId
string
crmCompanyId
string
isOverdue
boolean
contact
object
deal
object
crmCompany
object
assignee
object
assignees
object[]

Everyone in assigneeIds this response could resolve, primary first.