POST community/create-community

Create a community

Request Information

Headers

HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.

Sample:
        HTTP_AUTHORIZATION:
            OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D",
            oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D",
            oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg",
            oauth_signature_method="HMAC-SHA1",
            oauth_timestamp="1462882011",
            oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"
    

Body Parameters

NameDescriptionTypeAdditional information
community_name

Name

string

Required

community_short_name

Short name

string

Required

description

Brief Description

string

Required

tags

Tags (comma separated)

string

Required

type

Type: 0 for standard communities, 5 for static catalogs, 8 for static catalogs without members

integer

Required

access_type

Acces type: 0: public (Any user can be member), 1: private (Only users with invitation can be members), 2: restricted (users can request access, but admin must accept the requests), 3: reserved (private community childred of other private community)

integer

Required

parent_community_short_name

Parent community short name

string

Optional

admin_id

User identificator of the administrator of the community

globally unique identifier

Required

organization_short_name

Organization short name of the user

string

Optional

logo

Logo for the community

Collection of byte

Optional

Request Formats

application/json, text/json

Sample:
{
  "community_name": "Developers",
  "community_short_name": "developers",
  "description": "Developers community",
  "tags": "developers, devs, programming",
  "type": 0,
  "access_type": 0,
  "admin_id": "50b7615f-e32d-469d-ad93-d5829ab983ef",
  "logo": "CAk="
}

Response Information

Response HTTP status code

On success, the response contains 200 code.

On fail, throws a WebException with code:

  • 401 Unauthorized if the OAuth signature is invalid
  • 400 Bad Request if the params are invalid
  • 500 Internal server error if something goes wrong...