POST community/create-community-group

Add a group to the 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_short_name

Community short name

string

Required

group_short_name

Group short name

string

Required

group_name

Group name

string

Required

description

Description

string

Required

tags

Tags (comma separated)

Collection of string

Required

members

Initial members of the group

Collection of globally unique identifier

Optional

send_notification

True if a welcom message must be sent to the members of the group (by default false)

boolean

Optional

Request Formats

application/json, text/json

Sample:
{
  "community_short_name": "developers",
  "group_short_name": "administrators",
  "group_name": "Administrators",
  "description": "The community administrators",
  "tags": [
    "administrators",
    "admin"
  ],
  "members": [
    "874a2f99-795c-485f-bea7-4a39e59b05f5",
    "313a354f-ce25-49b6-a84e-85d9f977ec80"
  ],
  "send_notification": false
}

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...