Report that the app was uninstalled
- Path
/partners/domains/uninstall- Auth
- Partner token · partner server only
# $SIGNED_PAYLOAD: the request claims as a JWT signed with your private key, see https://releva.ai/documentation/reference/partners/overview/#authenticationcurl --request POST \ --url 'https://releva.ai/api/v0/partners/domains/uninstall' \ --header 'content-type: application/json' \ --header "x-rlv-partner-token: $RELEVA_PARTNER_TOKEN" \ --data "{\"payload\": \"$SIGNED_PAYLOAD\"}"Pauses the shop (running: false, runningSuspendedReason: appUninstalled, integrationActive: false) and sets
all its active and pending domain subscriptions to inactive, so billing stops. Safe to repeat. To undo, send
PUT /partners/domains with running: true (and integrationActive: true) and confirm a plan again.
Only for partners with external billing.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
The request fields as JWT claims, signed with your RSA private key (RS512 recommended; RS256/384 and PS256/384/512
are also accepted) with a short expiry (expiresIn: '1h'). The operation’s x-signed-claims schema lists the
claims.
Example generated
{ "payload": "example"}Responses
Section titled “Responses”Uninstalled.
object
The shop’s full domain record (about 100 fields; only the ones partners need are listed). On PUT and uninstall it
also contains account.
object
Public token for the browser and the SDKs.
Secret key for server-to-server calls. Keep it on your server.
Returned by POST only. Store token by name for the standard integration.
object
Example
{ "domain": { "url": "https://demo-partner-shop.example.com", "runningSuspendedReason": "appUninstalled", "disabledServices": [ "email", "textMessage" ] }}Partner token, shop lookup or billing mode error.
object
Human-readable error. Several validation errors are joined with a space.
Examples
{ "message": "Partner identification is missing!"}{ "message": "Partner identification is invalid!"}{ "message": "Domain with url demo-partner-internal.example.com cannot be found or you don't have access to it."}{ "message": "Partner Demo Partner Internal Billing it not allowed to use this API because it is not configured for external billing management. Actual value: internal"}The payload could not be verified (missing, not a JWT, signed with another key, or expired), or another unexpected error.
object
Human-readable error. Several validation errors are joined with a space.
Example
{ "message": "An internal error occurred."}