Skip to main content
POST
Creates a task on a project's board.

Authorizations

X-API-Key
string
header
required

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Path Parameters

projectId
string<uuid>
required

Project to create the task in.

Body

Task details.

Request body for creating a task inside a project section. The owning service provider is resolved from the request context, not from the body.

SectionId
string<uuid>
required

Identifier of the section the task belongs to. Required.

Title
string
required

Task title. Required.

Minimum string length: 1
Example:

"Migrate the finance mailboxes"

LeadAssigneeId
integer<int64> | null

Identifier of the technician leading the task. Optional.

AssistingAssigneeIds
integer<int64>[] | null

Identifiers of technicians assisting on the task.

WatcherIds
integer<int64>[] | null

Identifiers of technicians watching the task.

PriorityId
integer<int64>

Task priority: None=0, Urgent=1, High=2, Normal=3, Low=4 - the same scale a ticket uses. Defaults to Normal, which is what the app assigns a task created without one.

StatusId
integer<int64>

Task status: 1 Not started, 2 Working on it, 3 On hold, 4 Done. Defaults to 1 Not started.

DueDate
string<date-time> | null

When the task is due. UTC.

CreatedByName
string | null

Display name to record as the task creator. An API key is not a person, so when it is omitted or blank the creator is recorded as API.

CreatedOn
string<date-time> | null

When the task was created. UTC. Defaults to now - supply it only when importing a task that already existed elsewhere. Send only when importing history. A record with this field set sends no emails or notifications.

UpdatedOn
string<date-time> | null

When the task was last updated. UTC. Defaults to CreatedOn.

Response

OK

StatusCode
enum<integer>
Available options:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object

The identifier of the created task.

DataContext
object | null
Example:

null

Notifications
object[]