Pular para o conteúdo principal
POST
Posts a comment on a project.

Autorizações

X-API-Key
string
header
obrigatório

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.

Parâmetros de caminho

projectId
string<uuid>
obrigatório

Project to comment on.

Corpo

The comment.

Request body for posting a comment on a project.

Body
string
obrigatório

The comment body, as HTML. Required.

Minimum string length: 1
ConversationTypeId
integer<int64>

Kind of conversation: 1 Public or 2 Private. Defaults to 2 (Private) - a project comment posted by an integration is an internal note unless it says otherwise.

A project has no side conversations or approvals of its own, so 3 and 4 are rejected rather than silently written as something else.

ConversationId
string | null

Identifier of the conversation to post into. A project's comments are all on its one main thread, so there is no conversation to name and sending one is a 400.

Attachments
object[] | null

Files to attach. Upload them first, then send the returned name and url.

CreatedByName
string | null

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

CreatedOn
string<date-time> | null

When the comment was written. UTC. Defaults to now - supply it only when importing a comment that already existed elsewhere.

Resposta

OK

StatusCode
enum<integer>
Opções disponíveis:
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 comment.

DataContext
object | null
Exemplo:

null

Notifications
object[]