الانتقال إلى المحتوى الرئيسي
POST
Adds a section to a project.

التفويضات

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 to add the section to.

الجسم

Section details.

Request body for adding a section to a project.

Title
string
مطلوب

Section title. Required.

Minimum string length: 1
مثال:

"Discovery"

Color
string | null

Colour the section is displayed in, as a hex code. Optional - omit it and the section gets #56A0F9. A supplied blank is rejected: a section always has a colour.

مثال:

"#56A0F9"

CreatedByName
string | null

Display name to record as the author of this change. An API key is not a person, so when it is omitted or blank the author 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 created section.

DataContext
object | null
مثال:

null

Notifications
object[]