Add a ticket checklist item

Adds a manual checklist item to the end of the ticket checklist.

RBAC · ticket

Path parameters

idstring <uuid>Required

UUID path identifier from underlying resource tables.

Request body

Content type: application/json · schema WorkV1TicketChecklistCreateBody

item_namestringRequired

Checklist item name.

min length 1

descriptionstringNullable

is_requiredboolean

Whether the item gates ticket closure. Defaults to true.

Response body

Success response 201 · schema WorkV1ApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

201

Checklist item created.

400

Validation or request parsing failure.

401

API key missing/invalid.

403

RBAC denied for ticket resource action.

404

Ticket or sub-resource not found.

500

Unexpected controller/service failure.

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

cURL

curl -X POST "https://algapsa.com/api/v1/tickets/{id}/checklist" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "item_name": "x",
  "description": "string",
  "is_required": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/tickets/{id}/checklist", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "item_name": "x",
    "description": "string",
    "is_required": 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}/checklist");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""item_name"": ""x"",
  ""description"": ""string"",
  ""is_required"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

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