Passer au contenu principal
POST
Starts a side conversation on a task.

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 start the conversation on.

Corps

Who the conversation is with.

Request body for starting a side conversation on a task - a thread with somebody outside the task's own contacts, such as a vendor.

Name
string
requis

Display name of the person the conversation is with. Required.

Minimum string length: 1
Email
string
requis

Their email address. Required.

Minimum string length: 1
CcEmails
string[] | null

Addresses to copy on the conversation.

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 created conversation.

DataContext
object | null
Exemple:

null

Notifications
object[]