Skip to content

Removes the current user from a region. Returns 403 if not logged in, 400 if the region does not exist, 409 if the user is still an active store manager in the region, or 200 if the user was removed from the region or was not a member of that region. That means that after a 200 result the user will definitely not be a member of that region anymore.

POST
/api/region/{regionId}/leave

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Path Parameters

regionId*

which region or group to leave

Typeinteger
Required
Pattern"\\d+"

Responses

Success

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python