Skip to content

Create Channel Type

POST/web/v1/notification-channel-types/command/createWEB

Creates a new notification channel type definition.

Authentication

Requires a valid JWT token and Turnstile verification. Gateway validation: enableJwtToken=true, enableTurnstile=true.

Request Parameters

Request Body

NotificationChannelTypeCreateRequest:

NameTypeRequiredInDescription
channelCategorystringYesbodyChannel category enum: EMAIL
typeNamestringYesbodyType display name (max 128 characters)
typeDescriptionstringNobodyType description (max 512 characters)
displayOrderintegerNobodyDisplay sort order (default: 0)
iconUrlstringNobodyIcon URL (max 512 characters)
extraConfigstringNobodyExtra configuration as JSON string

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "ct_abc123",
    "typeCode": "EMAIL",
    "typeValue": 80010101,
    "typeName": "Email Notification",
    "typeDescription": "Standard email delivery",
    "typeStatus": "ENABLED",
    "displayOrder": 0,
    "iconUrl": null,
    "extraConfig": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T00:00:00Z"
  }
}

Error Responses

CodeDescription
4000Validation error (missing required fields)
4010Unauthorized (invalid or missing JWT token)
4030Turnstile verification failed

Notes

  • The typeCode and typeValue are derived from the channelCategory enum.
  • Channel types are created with ENABLED status by default.

Internal Documentation