Leave a Community

This endpoint allows to leave a community.

post
Leave a Community

https://api.whisk.com/community/v2/{community_id}/leave
You can use the following path parameter to leave a particular community:
Request
Response
Request
Path Parameters
community_id
required
string
The community identifier. For example, d25506c2690f4b81b2050b9b90bda3b7.
Headers
Authentication
required
string
User Access token containing community:write scope to authorize the API usage. For more information, see Authentication.
Response
200: OK
This is how a successful response looks.
{
"permissions": {
"role": "COMMUNITY_ROLE_INVALID",
"mode": "COMMUNITY_CONTRIBUTION_PERMISSION_MODE_INVALID",
"visibility": "COMMUNITY_VISIBILITY_INVALID"
}
}
400: Bad Request
This failed response appears when error codes are found in the endpoint query.
{
"error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
"message": "Additional details about error are not static and can be changed"
}
401: Unauthorized
This failed response appears due to API authentication failure. The possible error codes that may appear are: auth.tokenNotFound , auth.tokenExpired, auth.tokenInvalid, auth.tokenRequired.
{
"code": "auth.tokenNotFound"
}
500: Internal Server Error
This failed response appears when something is not right on Whisk's end. Please send a message to help@whisk.com, and be sure to include both the Request and Response data. We’ll get back to you soon.
This is unexpected response, something is wrong on our side, please contact: help@whisk.com

Sample Request and Response

Curl Request
Response
Curl Request
curl -X POST "https://api.whisk.com/community/v2/69129600a88f499795ec047c2b5f69c4/leave"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"

Whisk has its OpenAPI Specs published on Swagger to let you try out the API calls directly in your browser. You can call this endpoint here.

Response
{
"permissions": {
"role": "COMMUNITY_ROLE_UNSET",
"mode": "COMMUNITY_CONTRIBUTION_PERMISSION_MODE_ANYONE",
"visibility": "COMMUNITY_VISIBILITY_PUBLIC"
}
}