Skip to main content
PUT
Update Discord Embed

Authorizations

Authorization
string
header
required

You can retrieve your API key from your dashboard under Account > Developers.

Path Parameters

shopId
integer
required

The ID of the shop.

notificationId
string
required

The notification ID from Get Notification Settings.

Body

application/json
template
object

The embed template. Send null to reset to the default.

Example:
message
string

Text posted above the embed, for example a role mention (max 2000).

Example:

"<@&123> New order!"

Response

Plan does not include custom embeds

message
string
Example:

"Custom Discord embeds require the Business plan or higher."