Join a Community

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

Join a Community

POST https://api.whisk.com/community/v2/{community_id}/join

You can use the following path parameter to join a particular community:

Path Parameters

Name

Type

Description

community_id

string

The community identifier. For example, d25506c2690f4b81b2050b9b90bda3b7.

Headers

Name

Type

Description

Authentication

string

User Access token containing community:write scope to authorize the API usage. For more information, see Authentication.

{
  "permissions": {
    "role": "COMMUNITY_ROLE_INVALID",
    "mode": "COMMUNITY_CONTRIBUTION_PERMISSION_MODE_INVALID",
    "visibility": "COMMUNITY_VISIBILITY_INVALID"
  }
}

{
  "error_code": "REAL_CODES_ARE_IN_ENDPOINT_DESCRIPTION",
  "message": "Additional details about error are not static and can be changed"
}

{
  "code": "auth.tokenNotFound"
}

This is unexpected response, something is wrong on our side, please contact: [email protected]

Sample Request and Response

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.

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

PreviousRemove a Recipe from a Community

NextLeave a Community

Last updated 5 years ago

Was this helpful?