Skip to main content
POST
/
v1
/
users
/
me
/
notifications
/
channels
/
{id}
/
test
Test a notification channel
curl --request POST \
  --url http://localhost:8080/v1/users/me/notifications/channels/{id}/test \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "channel": {
    "id": "unc_cq1234567890abcdef",
    "user_id": "<string>",
    "channel_type": "email",
    "name": "<string>",
    "config": {},
    "is_verified": true,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Merchant API key: ak_live_... or ak_test_...

Path Parameters

id
string
required

Resource identifier (xid format)

Response

Test result

success
boolean
message
string
channel
object