PUT/api/v1/boards/{id}

Update board

Updates an existing board. All fields are optional — only send the fields you want to change.

RBAC · ticket

Path parameters

idstring <uuid>Required

Board UUID.

Request body

Content type: application/json · schema BoardUpdateRequest

board_namestring

min length 1 · max length 255

descriptionstring

max length 1000

is_defaultboolean

is_inactiveboolean

category_typestring

Enum: customitil

priority_typestring

Enum: customitil

default_assigned_tostring <uuid>Nullable

display_itil_impactboolean

display_itil_urgencyboolean

enable_live_ticket_timerboolean

Response body

Success response 200 · schema BoardEnvelope

dataobjectRequired

board_idstring <uuid>Required

board_namestringRequired

descriptionstringRequiredNullable

display_ordernumberRequired

is_defaultbooleanRequired

is_inactivebooleanRequired

category_typestringRequiredNullable

Enum: customitil

priority_typestringRequiredNullable

Enum: customitil

display_itil_impactbooleanRequiredNullable

display_itil_urgencybooleanRequiredNullable

default_assigned_tostring <uuid>RequiredNullable

inbound_reply_reopen_enabledboolean

inbound_reply_reopen_cutoff_hoursinteger

inbound_reply_reopen_status_idstring <uuid>Nullable

inbound_reply_ai_ack_suppression_enabledboolean

enable_live_ticket_timerbooleanRequiredNullable

tenantstring <uuid>Required

Response codes

200

Board updated successfully.

400

Validation error.

401

Authentication failed.

404

Board not found.

PUT /api/v1/boards/{id}

cURL

curl -X PUT "https://algapsa.com/api/v1/boards/{id}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "board_name": "x",
  "description": "string",
  "is_default": false,
  "is_inactive": false,
  "category_type": "custom",
  "priority_type": "custom",
  "default_assigned_to": "01HN2K7VRB9PQ3Y0000000000",
  "display_itil_impact": false,
  "display_itil_urgency": false,
  "enable_live_ticket_timer": false
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/boards/{id}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "board_name": "x",
    "description": "string",
    "is_default": false,
    "is_inactive": false,
    "category_type": "custom",
    "priority_type": "custom",
    "default_assigned_to": "01HN2K7VRB9PQ3Y0000000000",
    "display_itil_impact": false,
    "display_itil_urgency": false,
    "enable_live_ticket_timer": false
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/boards/{id}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""board_name"": ""x"",
  ""description"": ""string"",
  ""is_default"": false,
  ""is_inactive"": false,
  ""category_type"": ""custom"",
  ""priority_type"": ""custom"",
  ""default_assigned_to"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""display_itil_impact"": false,
  ""display_itil_urgency"": false,
  ""enable_live_ticket_timer"": false
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": {
    "board_id": "01HN2K7VRB9PQ3Y0000000000",
    "board_name": "string",
    "description": "string",
    "display_order": 0,
    "is_default": false,
    "is_inactive": false,
    "category_type": "custom",
    "priority_type": "custom",
    "display_itil_impact": false,
    "display_itil_urgency": false,
    "default_assigned_to": "01HN2K7VRB9PQ3Y0000000000",
    "inbound_reply_reopen_enabled": false,
    "inbound_reply_reopen_cutoff_hours": 1,
    "inbound_reply_reopen_status_id": "01HN2K7VRB9PQ3Y0000000000",
    "inbound_reply_ai_ack_suppression_enabled": false,
    "enable_live_ticket_timer": false,
    "tenant": "01HN2K7VRB9PQ3Y0000000000"
  }
}