Notification Settings

Update merchant email notification settings

Creates or updates the email notification settings for the given merchant. Set emailEnabled to true and provide at least one recipient to start receiving email notifications on order events.

put/api/v1/merchants/{merchantId}/notification-settings

Request

  • Base URL: https://api-sandbox.koywe.com
  • URL: https://api-sandbox.koywe.com/api/v1/merchants/{merchantId}/notification-settings
  • Auth: HTTP bearer

Path parameters

merchantIdstring required

Merchant ID

Request body

emailEnabledboolean required

Whether email notifications are enabled for this merchant

recipientsstring[]

List of recipient email addresses for order notifications. Optional when emailEnabled is false; at least one valid email required when emailEnabled is true.

Example request

{
  "emailEnabled": true,
  "recipients": [
    "ops@merchant.com",
    "finance@merchant.com"
  ]
}

Response

Updated notification settings

emailEnabledboolean required

Whether email notifications are enabled for this merchant

recipientsstring[] required

List of recipient email addresses

Example response

{
  "recipients": [
    "ops@merchant.com"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.