Passer au contenu principal
PATCH
Updates a task. Send only the fields you want to change.

Autorisations

X-API-Key
string
header
requis

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.

Paramètres de chemin

projectId
string<uuid>
requis

Project the task belongs to.

taskId
string<uuid>
requis

Task to update.

Corps

Fields to change.

Request body for updating a task. Every field is optional - send only what you want to change. An omitted field leaves the stored value alone; sending nothing at all is a 400 rather than a no-op write.

Title
string | null

New task title.

SectionId
string<uuid> | null

Section to move the task to. Must be an active section of the same project.

StatusId
integer<int64> | null

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

StatusReason
string | null

Free-text reason recorded with the status. Only read when StatusId is sent.

PriorityId
integer<int64> | null

New priority: None=0, Urgent=1, High=2, Normal=3, Low=4 - the ticket scale.

DueDate
string<date-time> | null

New due date (UTC). Send null to leave it alone; to clear it, send ClearDueDate.

ClearDueDate
boolean | null

Set true to remove the due date. A task's due date is otherwise never cleared by omission.

LeadAssigneeId
integer<int64> | null

New lead assignee. Send 0 to remove the lead.

AssistingAssigneeIds
integer<int64>[] | null

Replaces the assisting assignees outright. Send an empty array to remove them all.

WatcherIds
integer<int64>[] | null

Replaces the watchers outright. Send an empty array to remove them all.

BlockedByTaskIds
string<uuid>[] | null

Replaces the tasks that must finish before this one can.

BlockingTaskIds
string<uuid>[] | null

Replaces the tasks this one is blocking.

AgentAssetIds
string<uuid>[] | null

Replaces the linked agent-managed assets.

CustomAssetIds
string<uuid>[] | null

Replaces the linked custom assets.

UptimeIds
string<uuid>[] | null

Replaces the linked uptime checks.

Banner
string | null

New banner text. Send an empty string to remove it.

UpdatedByName
string | null

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

Réponse

OK

StatusCode
enum<integer>
Options disponibles:
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 updated task.

DataContext
object | null
Exemple:

null

Notifications
object[]