Create Channel Type
POST
/web/v1/notification-channel-types/command/create WEBCreates a new notification channel type definition.
Required Headers
| Header | Example Value | Description |
|---|---|---|
| Content-Type | application/json | Request content type |
| Accept | application/json | Expected response type |
| X-Client-Hash | Client device fingerprint | |
| Accept-Language | en, zh, zh-Hant, ja, vi | Response language (default: en) |
| Authorization | Bearer | JWT access token |
Request Parameters
Request Body
NotificationChannelTypeCreateRequest:
| Name | Type | Required | In | Description |
|---|---|---|---|---|
channelCategory | string | Required | body | Channel category enum: EMAIL |
typeName | string | Required | body | Type display name (max 128 characters) |
typeDescription | string | Optional | body | Type description (max 512 characters) |
displayOrder | integer | Optional | body | Display sort order (default: 0) |
iconUrl | string | Optional | body | Icon URL (max 512 characters) |
extraConfig | string | Optional | body | Extra configuration as JSON string |
Success Response
Success 200
{
"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
| Code | Description |
|---|---|
4000 | Validation error (missing required fields) |
4010 | Unauthorized (invalid or missing JWT token) |
4030 | Turnstile verification failed |
Notes
- The
typeCodeandtypeValueare derived from thechannelCategoryenum. - Channel types are created with
ENABLEDstatus by default.