Merchant App Uninstall
A
MERCHANT_DISCONNECTED
webhook is emitted upon successful merchant disconnection.A
STORE_DISCONNECTED
notification will be sent to the Channel Dashboard.Disconnecting will remove your access to the merchant's offers. To restore access in the future, the merchant will need to complete the Violet Connect process again.
Send a request to uninstall (disconnect) a Merchant from the given App
Path parameters
app_idinteger · int32Required
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
A Request to uninstall/disconnect a merchant from an app
idinteger · int64Read-onlyOptional
app_idinteger · int32Optional
ID of the App to uninstall from
merchant_idinteger · int32Required
ID of Merchant being uninstalled
Responses
default
default response
application/json
post
POST /v1/apps/{app_id}/merchants/uninstall HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"app_id": 1,
"merchant_id": 1
}
default
default response
{
"id": 1,
"app_id": 1,
"merchant_id": 1,
"scope": "text",
"status": "REQUESTED",
"install_source": "DIRECT",
"commission_rate": 1,
"commission_locked": true,
"date_created": "2025-07-10T05:50:04.605Z",
"date_last_modified": "2025-07-10T05:50:04.605Z"
}
Last updated
Was this helpful?