SellApp
ApiResourcesStore settings

Manage a notification channel

Retrieve, replace, update, or delete one store-scoped notification destination.

Channel identifiers are zero-based list indexes. Deleting a channel compacts later indexes, so refresh the list before another mutation.

PATCH accepts partial channel attributes and retains an existing write-only Discord webhook when webhook is omitted from a Discord-to-Discord update. Changing the channel type discards fields from the previous type, so changing an email channel to Discord requires a new webhook. PUT requires a complete channel representation.

GET
/v2/store/notification-channels/{notificationChannel}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

notificationChannel*integer

The notificationChannel path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/store/notification-channels/0"
{
  "data": {
    "id": 0,
    "type": "email",
    "email": "user@example.com",
    "channel": "string",
    "webhook_configured": true,
    "allowed_notifications": [
      "string"
    ]
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PATCH
/v2/store/notification-channels/{notificationChannel}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

notificationChannel*integer

The notificationChannel path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://sell.app/api/v2/store/notification-channels/0" \  -H "Content-Type: application/json" \  -d '{    "channel": {}  }'
{
  "data": {
    "id": 0,
    "type": "email",
    "email": "user@example.com",
    "channel": "string",
    "webhook_configured": true,
    "allowed_notifications": [
      "string"
    ]
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
PUT
/v2/store/notification-channels/{notificationChannel}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

notificationChannel*integer

The notificationChannel path parameter.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://sell.app/api/v2/store/notification-channels/0" \  -H "Content-Type: application/json" \  -d '{    "channel": {      "type": "email",      "email": "user@example.com",      "allowed_notifications": [        "string"      ]    }  }'
{
  "data": {
    "id": 0,
    "type": "email",
    "email": "user@example.com",
    "channel": "string",
    "webhook_configured": true,
    "allowed_notifications": [
      "string"
    ]
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}
DELETE
/v2/store/notification-channels/{notificationChannel}

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Path Parameters

notificationChannel*integer

The notificationChannel path parameter.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://sell.app/api/v2/store/notification-channels/0"
{
  "data": {
    "id": 0,
    "type": "email",
    "email": "user@example.com",
    "channel": "string",
    "webhook_configured": true,
    "allowed_notifications": [
      "string"
    ]
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "Rule not found."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}