Skip to main content
POST

Authorizations

​
x-client-key
string
header
required
​
x-client-secret
string
header
required

Path Parameters

​
workspaceId
string<uuid>
required

UUID of the workspace. Must be your key's own workspace.

Example:

"cb363f7e-c52a-4478-911d-f6a6f791090e"

Body

application/json
​
title
string
required

Task title. The only required field.

Example:

"Reset the endcap planogram"

​
description
string
Example:

"Swap in the new seasonal set"

​
additionalDescription
string
​
priority
string
Example:

"High"

​
assignees
string<uuid>[]

User, team OR location IDs, interchangeably. Mutually exclusive with assigneesRoles.

​
assigneesRoles
object

Role-based targeting. Mutually exclusive with assignees.

​
locationIds
string<uuid>[]
​
checklistId
string<uuid>

Template to attach.

​
serviceTypeId
string<uuid>

Task category / service type.

​
attachment
string[]
​
startTime
string

ISO-8601; always include the offset.

Example:

"2026-08-04T09:00:00-04:00"

​
dueTime
string

ISO-8601; always include the offset.

Example:

"2026-08-04T17:00:00-04:00"

​
endDate
string

End of the schedule window for recurring work.

​
dateFrom
string

Earliest date the task may start. Note: startDate is derived, not accepted.

​
taskStatus
string

Starting status. Defaults to Open.

Example:

"Open"

​
isTimeBound
boolean
default:false
​
recurringTask
boolean
​
instanceCadence
object
​
isMultiTasks
boolean

Create one separate task per assignee.

​
isAutoTagLocation
boolean

Derive locationIds from each assignee.

​
isProject
boolean

Create a recurring project instead of a one-off task. Requires the Projects feature.

​
projectType
enum<string>

Required shape when isProject is true.

Available options:
user,
asset,
role
​
assets
string<uuid>[]

Required when projectType is asset.

Response

Task(s) created.