Skip to content

Create Channel Type

POST/web/v1/notification-channel-types/command/create WEB

Creates a new notification channel type definition.

Required Headers

HeaderExample ValueDescription
Content-Typeapplication/jsonRequest content type
Acceptapplication/jsonExpected response type
X-Client-HashClient device fingerprint
Accept-Languageen, zh, zh-Hant, ja, viResponse language (default: en)
AuthorizationBearerJWT access token

Request Parameters

Request Body

NotificationChannelTypeCreateRequest:

NameTypeRequiredInDescription
channelCategorystringRequiredbodyChannel category enum: EMAIL
typeNamestringRequiredbodyType display name (max 128 characters)
typeDescriptionstringOptionalbodyType description (max 512 characters)
displayOrderintegerOptionalbodyDisplay sort order (default: 0)
iconUrlstringOptionalbodyIcon URL (max 512 characters)
extraConfigstringOptionalbodyExtra 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

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.

SlaunchX Internal Documentation