Create Group

POST https://api.speakap.io/networks/:eid/groups/

Use cases

  • Create public groups
  • Create restricted or private groups
  • Create secret groups
  • Create subgroups of the above types

Request

URI:/networks/{networkEID}/groups/
Method:POST
Content-Type:application/json

Authentication

OAuth 2.0

Parameters

Name Type Description
networkEID EID Network EID

Query Parameters

Name Type Description
join boolean Whether or not the logged-in user will auto-join Default: false for non-basic groups, true for basic groups without a parent or when already a member of parent

Request body

Supply a complete group resource in the request body possibly supplemented with a parent object. You should omit created date as it will be set server-side.

Name Type Description
parent object Parent group
parent. EID EID Unique entity identifier
parent. type string Group type

Examples

{
    "groupType": "public",
    "name": "Support the team",
    "description": "Gotta support the team"
}

Subgroup:

{
    "groupType": "private",
    "parent": {
        "EID": "1234567890ABCDEF",
        "type": "group"
    },
    "name": "Work council"
}

Response

202
Accepted for insertion: returns a Feedback object
400
Invalid data: returns an Error object
403
Unauthorized: returns an Error object
404
Unknown network: returns an Error object