POST https://api.speakap.io/networks/:eid/groups/
Request
URI: | /networks/{networkEID}/groups/ |
---|---|
Method: | POST |
Content-Type: | application/json |
OAuth 2.0
Name | Type | Description |
---|---|---|
networkEID | EID | Network EID |
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 |
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 |
{
"groupType": "public",
"name": "Support the team",
"description": "Gotta support the team"
}
Subgroup:
{
"groupType": "private",
"parent": {
"EID": "1234567890ABCDEF",
"type": "group"
},
"name": "Work council"
}
Response