الانتقال إلى المحتوى الرئيسي
PATCH
Updates a section's title or colour. Send only the fields you want to change.

التفويضات

X-API-Key
string
header
مطلوب

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.

معلمات المسار

projectId
string<uuid>
مطلوب

Project the section belongs to.

sectionId
string<uuid>
مطلوب

Section to update.

الجسم

Fields to change.

Request body for updating a section. Both fields are optional; send only what you want to change.

Neither field is clearable: a section always has a title and a colour, so an omitted field leaves the stored value alone and a supplied blank is rejected.

Title
string | null

New section title. Omit to leave unchanged.

Color
string | null

New colour, as the app stores it. Omit to leave unchanged.

مثال:

"#56A0F9"

UpdatedByName
string | null

Display name to record as the author of this change. Omitted or blank, it is recorded as API.

الاستجابة

OK

StatusCode
enum<integer>
الخيارات المتاحة:
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 section.

DataContext
object | null
مثال:

null

Notifications
object[]