Skip to content

Update Notification Channel

POST/web/v1/notification-channels/command/updateWEB

Updates an existing notification channel. Supports partial update -- only non-null fields are modified.

Authentication

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

Request Parameters

Request Body

NotificationChannelUpdateRequest:

NameTypeRequiredInDescription
bizIdstringYesbodyChannel business ID (max 64 characters)
channelNamestringNobodyNew channel name (max 255 characters)
channelRemarkstringNobodyNew channel remark (max 255 characters)
channelHoststringNobodyNew channel host (max 512 characters)
channelStatusstringNobodyNew status: ACTIVE, INACTIVE, PENDING, ERROR
emailConfigobjectNobodyUpdated email configuration (see Create endpoint for field details)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "ch_abc123",
    "institutionBizId": "inst_abc123",
    "channelName": "Updated Email",
    "channelRemark": "Production channel",
    "channelHost": "smtp.example.com",
    "channelCategory": "EMAIL",
    "channelStatus": "ACTIVE",
    "emailConfig": {
      "smtpHost": "smtp.example.com",
      "smtpPort": 587,
      "senderEmail": "noreply@example.com",
      "senderName": "Acme Corp",
      "username": "noreply@example.com",
      "password": "******",
      "useSsl": true,
      "useStartTls": false,
      "connectionTimeout": 10000,
      "readTimeout": 30000
    },
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T01:00:00Z",
    "createdBy": "user_xyz",
    "updatedBy": "user_xyz"
  }
}

Error Responses

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

Notes

  • Only fields provided in the request body are updated; omitted fields remain unchanged.
  • The password is masked in the response.

Internal Documentation