Update ticket status

Updates ticket status, with optional per-operation notification suppression.

RBAC · ticket

Path parameters

idstring <uuid>Required

UUID path identifier from underlying resource tables.

Request body

Content type: application/json · schema WorkV1TicketStatusUpdateBody

status_idstring <uuid>Required

closed_atstring <date-time>

closed_bystring <uuid>

override_close_rulesboolean

override_close_rules_reasonstringNullable

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.

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.

PUT /api/v1/tickets/{id}/status

cURL

curl -X PUT "https://algapsa.com/api/v1/tickets/{id}/status" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status_id": "01HN2K7VRB9PQ3Y0000000000",
  "closed_at": "2026-04-18T15:22:14Z",
  "closed_by": "01HN2K7VRB9PQ3Y0000000000",
  "override_close_rules": false,
  "override_close_rules_reason": "string",
  "suppressContactNotifications": false,
  "suppressInternalNotifications": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/tickets/{id}/status", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status_id": "01HN2K7VRB9PQ3Y0000000000",
    "closed_at": "2026-04-18T15:22:14Z",
    "closed_by": "01HN2K7VRB9PQ3Y0000000000",
    "override_close_rules": false,
    "override_close_rules_reason": "string",
    "suppressContactNotifications": false,
    "suppressInternalNotifications": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/tickets/{id}/status");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""status_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""closed_at"": ""2026-04-18T15:22:14Z"",
  ""closed_by"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""override_close_rules"": false,
  ""override_close_rules_reason"": ""string"",
  ""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": {}
}