Join a Community

This endpoint allows to become a member of a public community.

post
Join a Community

https://api.whisk.com/community/v2/{community_id}/join
You can use the following path parameter to join 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 [email protected], 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: [email protected]

Sample Request and Response

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

Whisk allows you to discover and understand its API capabilities on the Swagger interface with the ability to try out the API calls directly in your browser. You can call this endpoint here.

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