Projects

Posts a comment on a task.

Comments default to ConversationTypeId: 2 (Private). Any other kind is outward-facing, so posting one puts the task in a waiting-on-the-contact state and fires the same automation the app does.

Side Conversation (3) and Approval (4) need the ConversationId of a conversation that already exists on this task - list them with the conversations endpoint.

Attach files by uploading them first and sending back the name and url you were given. Any access token on a url is stripped before storage and a fresh one is issued whenever the comment is read, so never store the url you get back.

POST

projects

{projectId}

tasks

{taskId}

comments

Posts a comment on a task.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Body": "<string>",
  "ConversationTypeId": 123,
  "ConversationId": "<string>",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ],
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments"

payload = {
    "Body": "<string>",
    "ConversationTypeId": 123,
    "ConversationId": "<string>",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ],
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Body: '<string>',
    ConversationTypeId: 123,
    ConversationId: '<string>',
    Attachments: [{Name: '<string>', Url: '<string>'}],
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Body' => '<string>',
    'ConversationTypeId' => 123,
    'ConversationId' => '<string>',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ],
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments"

	payload := strings.NewReader("{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

授权

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 task belongs to.

taskId

string<uuid>

必填

Task to comment on.

请求体

The comment.

Request body for posting a comment on a task.

Body

string

必填

The comment body, as HTML. Required.

Minimum string length: 1

ConversationTypeId

integer<int64>

Kind of conversation: 1 Public, 2 Private, 3 Side Conversation, 4 Approval. Defaults to 2 (Private) - a comment posted by an integration is an internal note unless it says otherwise.

ConversationId

string | null

Identifier of the conversation to post into, from the task's conversations endpoint. Required for Side Conversation and Approval, and rejected for Public and Private, which are the task's main thread.

Attachments

object[] | null

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

Show child attributes

CreatedByName

string | null

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

CreatedOn

string<date-time> | null

When the comment was written. UTC. Defaults to now. Send only when importing history. A record with this field set sends no emails or notifications.

响应

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 comment.

Show child attributes

DataContext

object | null

示例:

null

Notifications

object[]

Show child attributes

⌘I

Posts a comment on a task.

curl --request POST \
  --url https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments \
  --header 'Content-Type: application/json-patch+json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "Body": "<string>",
  "ConversationTypeId": 123,
  "ConversationId": "<string>",
  "Attachments": [
    {
      "Name": "<string>",
      "Url": "<string>"
    }
  ],
  "CreatedByName": "<string>",
  "CreatedOn": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments"

payload = {
    "Body": "<string>",
    "ConversationTypeId": 123,
    "ConversationId": "<string>",
    "Attachments": [
        {
            "Name": "<string>",
            "Url": "<string>"
        }
    ],
    "CreatedByName": "<string>",
    "CreatedOn": "2023-11-07T05:31:56Z"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    Body: '<string>',
    ConversationTypeId: 123,
    ConversationId: '<string>',
    Attachments: [{Name: '<string>', Url: '<string>'}],
    CreatedByName: '<string>',
    CreatedOn: '2023-11-07T05:31:56Z'
  })
};

fetch('https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Body' => '<string>',
    'ConversationTypeId' => 123,
    'ConversationId' => '<string>',
    'Attachments' => [
        [
                'Name' => '<string>',
                'Url' => '<string>'
        ]
    ],
    'CreatedByName' => '<string>',
    'CreatedOn' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments"

	payload := strings.NewReader("{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usw.gorelo.io/v1/projects/{projectId}/tasks/{taskId}/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"Body\": \"<string>\",\n  \"ConversationTypeId\": 123,\n  \"ConversationId\": \"<string>\",\n  \"Attachments\": [\n    {\n      \"Name\": \"<string>\",\n      \"Url\": \"<string>\"\n    }\n  ],\n  \"CreatedByName\": \"<string>\",\n  \"CreatedOn\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": {
    "Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "DataContext": null,
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}

{
  "StatusCode": 100,
  "IsSuccess": true,
  "Data": null,
  "DataContext": {
    "TraceId": "<string>"
  },
  "Notifications": [
    {
      "Code": "070101",
      "Message": "<string>",
      "PropertyName": "<string>",
      "ActionHint": "<string>",
      "DocUrl": "<string>"
    }
  ]
}