Bulk Merchant App Uninstall

  • A MERCHANT_DISCONNECTED webhook is emitted upon each successful merchant disconnection.

  • A STORE_DISCONNECTED notification will be sent to the Channel Dashboard upon each successful merchant disconnection.

  • 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.

  • For any failed disconnections, the response will include the affected Merchant IDs and their corresponding failure reasons.

Bulk Merchant App Uninstall

post

Send a request to disconnect multiple merchants 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 disconnect multiple merchants from an app

merchant_idsinteger · int32[]Optional
Responses
200
successful operation
application/json
post
POST /v1/apps/{app_id}/merchants/uninstall/bulk 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: 20

{
  "merchant_ids": [
    1
  ]
}
200

successful operation

{
  "errors": [
    {
      "merchant_id": 10064,
      "message": "App install could not be found."
    },
    {
      "merchant_id": 10065,
      "message": "Merchant could not be found."
    }
  ]
}

Last updated

Was this helpful?