Skip to content

Update Channel Type

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

Updates an existing notification channel type. Supports partial update.

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

NotificationChannelTypeUpdateRequest:

NameTypeRequiredInDescription
bizIdstringRequiredbodyType business ID (max 64 characters)
typeNamestringOptionalbodyNew type name (max 128 characters)
typeDescriptionstringOptionalbodyNew type description (max 512 characters)
typeStatusstringOptionalbodyNew status: ENABLED, DISABLED
displayOrderintegerOptionalbodyNew display sort order
iconUrlstringOptionalbodyNew icon URL (max 512 characters)
extraConfigstringOptionalbodyNew extra configuration as JSON string

Success Response

Success 200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "ct_abc123",
    "typeCode": "EMAIL",
    "typeValue": 80010101,
    "typeName": "Updated Email Type",
    "typeDescription": "Updated description",
    "typeStatus": "ENABLED",
    "displayOrder": 1,
    "iconUrl": null,
    "extraConfig": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T01:00:00Z"
  }
}

Error Responses

CodeDescription
4000Validation error (missing bizId)
4010Unauthorized (invalid or missing JWT token)
4030Turnstile verification failed
4040Channel type not found

Notes

  • Only non-null fields are updated; omitted fields remain unchanged.

SlaunchX Internal Documentation