PUT /api/v1/groups/{group_id}
Update a group's parameters.
All body parameters are optional.
| Parameter name | Mandatory | Type | Description |
|---|---|---|---|
name | No | String | New name for the group. |
public | No | String | "true" to make the group public "false" to make the group private. |
custom | No | String | Value of the field "Additional information" of the group. |
parent | No | String | ID of the new parent group. |
bannerImageId | No | String | Database ID of the image stored. |
privacyPolicy | No | Object | "url": string "explicitConsent": true/false |
moderationCharter | No | Object | "url": string "explicitConsent": true/false |
termsOfUse | No | Object | "url": string "explicitConsent": true/false |
Servers
- https://app.360learning.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
group_id |
String | Yes |
group's id |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
company |
String | No |
(Optional) Include the company ID to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
apiKey |
String | No |
(Optional) Include the API key to authenticate calls via the API key as query parameter. For more information on the authentication methods supported by our API, see Authentication Methods. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
custom |
String | No | |
name |
String | No | |
privacyPolicy |
Object | No | |
privacyPolicy.explicitConsent |
Boolean | No | |
privacyPolicy.url |
String | No | |
public |
String | No | |
parent |
String | No | |
termsOfUse |
Object | No | |
termsOfUse.explicitConsent |
Boolean | No | |
termsOfUse.url |
String | No | |
moderationCharter |
Object | No | |
moderationCharter.explicitConsent |
Boolean | No | |
moderationCharter.url |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.