Skip to main content
POST
Create a comment type

Restrictions

Usage

  • The new type is appended to the end of the display ordering.
  • The name must be unique within the account (case-insensitive, after trimming whitespace).
  • An account can have at most 10 comment types.
  • This permission is admin-only by default; custom roles must be granted it explicitly.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Parameters for creating a comment type.

name
string
required

Display name. Trimmed before storing; must be unique within the account (case-insensitive). At most 40 characters.

Maximum string length: 40
color
string
required

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
required

Result of creating a comment type.