POST/api/v1/tickets/{id}/comments

Product availabilityAlgaPSAAlgaDesk

Add ticket comment

Adds a comment to the ticket, with optional per-operation notification suppression.

RBAC · ticket

Path parameters

idstring <uuid>Required

UUID path identifier from underlying resource tables.

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

fieldsstringOptional

searchstringOptional

querystringOptional

Request body

Content type: application/json · schema WorkV1TicketCommentCreateBody

comment_textstringRequired

min length 1 · max length 5000

is_internalboolean

default false

is_resolutionboolean

default false

time_spentnumber

≥ 0

metadataobject

parent_comment_idstring <uuid>

scheduled_publish_atstring <date-time>

Withhold this client-visible comment until this future instant (ISO 8601). Requires scheduled_publish_tz; not allowed with is_internal or when replying into an internal thread.

scheduled_publish_tzstring

IANA time zone the author scheduled in, e.g. America/New_York.

max length 64

ccarray of string

One-off Cc recipients for this comment's email only. They are never added to the ticket watch list and receive no later comments. Not allowed with is_internal. Max 20 cc + bcc combined.

max items 20

itemsstring <email>

bccarray of string

One-off Bcc recipients for this comment's email only. Never returned to client-portal callers. Not allowed with is_internal. Max 20 cc + bcc combined.

max items 20

itemsstring <email>

suppressContactNotificationsboolean

When true, suppresses customer-facing email and portal notifications for this operation.

suppressInternalNotificationsboolean

When true, also suppresses agent and watcher notifications. Requires suppressContactNotifications=true.

Response body

Success response 200 · schema WorkV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

Operation succeeded.

201

Create-like operation succeeded.

400

Validation or request parsing failure.

401

API key missing/invalid or associated user missing.

403

RBAC denied for ticket resource action.

404

Target resource not found.

500

Unexpected controller/service failure.

POST /api/v1/tickets/{id}/comments

cURL

curl -X POST "https://algapsa.com/api/v1/tickets/{id}/comments?page=string&limit=string&sort=string&order=asc&fields=string&search=string" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "comment_text": "x",
  "is_internal": false,
  "is_resolution": false,
  "time_spent": 0,
  "metadata": {},
  "parent_comment_id": "01HN2K7VRB9PQ3Y0000000000",
  "scheduled_publish_at": "2026-04-18T15:22:14Z",
  "scheduled_publish_tz": "string",
  "cc": [
    "user@example.com"
  ],
  "bcc": [
    "user@example.com"
  ],
  "suppressContactNotifications": false,
  "suppressInternalNotifications": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/tickets/{id}/comments?page=string&limit=string&sort=string&order=asc&fields=string&search=string", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "comment_text": "x",
    "is_internal": false,
    "is_resolution": false,
    "time_spent": 0,
    "metadata": {},
    "parent_comment_id": "01HN2K7VRB9PQ3Y0000000000",
    "scheduled_publish_at": "2026-04-18T15:22:14Z",
    "scheduled_publish_tz": "string",
    "cc": [
      "user@example.com"
    ],
    "bcc": [
      "user@example.com"
    ],
    "suppressContactNotifications": false,
    "suppressInternalNotifications": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/tickets/{id}/comments?page=string&limit=string&sort=string&order=asc&fields=string&search=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""comment_text"": ""x"",
  ""is_internal"": false,
  ""is_resolution"": false,
  ""time_spent"": 0,
  ""metadata"": {},
  ""parent_comment_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""scheduled_publish_at"": ""2026-04-18T15:22:14Z"",
  ""scheduled_publish_tz"": ""string"",
  ""cc"": [
    ""user@example.com""
  ],
  ""bcc"": [
    ""user@example.com""
  ],
  ""suppressContactNotifications"": false,
  ""suppressInternalNotifications"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {},
  "meta": {}
}