Skip to main content
POST
Update a comment type

Restrictions

Usage

  • Partial update — only the provided fields are changed, but at least one of name or color must be provided.
  • The name must remain unique within the account (case-insensitive, after trimming whitespace).
  • This permission is admin-only by default; custom roles must be granted it explicitly.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json

Parameters for updating a comment type. Partial update: at least one of name or color must be provided.

comment_type_id
string
required

ID of the comment type to update (24-character hex ObjectID).

Pattern: ^[0-9a-fA-F]{24}$
name
string

New display name. Trimmed before storing; must be unique within the account (case-insensitive). At most 40 characters. Must not contain control or text-direction characters.

Maximum string length: 40
color
string

New label color as a hex value in #RRGGBB format. Normalized to uppercase.

Pattern: ^#[0-9A-Fa-f]{6}$

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

No payload. Depending on the operation, data is {} or omitted from the envelope; rely only on the HTTP 200 status and the absence of error.