36360learning
Groups

Edit a group

Changed on

🔑

Required OAuth scope: groups:write.

Edits specific fields of an existing group. Fields not included in the request payload remain unchanged.

patch/api/v2/groups/{groupId}

Request

  • Base URL
    https://app.360learning.com
  • URL
    https://app.360learning.com/api/v2/groups/{groupId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: /api/v2/oauth2/token

Path parameters

groupIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the group.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

customstring nullable

A custom field to store information available only in the General settings of the group, the CSV exports, and the API. This information is not displayed to learners on the platform.

namestring

The name of the group.

publicboolean

True if the group is public; false if the group is private.

parentIdstring ObjectId

The unique ID of the parent group. It must not be the updated group or one of its descendants.

bannerImageIdstring ObjectId nullable

The banner image of the group. Ensure that given media is an image with the proper size (at least 980px wide and 370px high).

backgroundImageIdstring ObjectId nullable

The background image of the group. Ensure that given media is an image with the proper size (at least 760px wide and 880px high).

faviconImageIdstring ObjectId nullable

The favicon image of the group. Ensure that given media is an image with the proper size (less than 500px wide and 500px high and more than 16px wide and 16px high).

logoImageIdstring ObjectId nullable

The logo image of the group.

subdomainstring nullable

The subdomain of the group.

urlstring nullable

The custom url of the group.

Example request

{
  "custom": "Unit 102",
  "name": "Marketing Team",
  "parentId": "507f1f77bcf86cd799439011",
  "bannerImageId": "507f1f77bcf86cd799439011",
  "backgroundImageId": "507f1f77bcf86cd799439011",
  "faviconImageId": "507f1f77bcf86cd799439011",
  "logoImageId": "507f1f77bcf86cd799439011",
  "privacyPolicy": {
    "url": "https://example.com/policy"
  },
  "moderationCharter": {
    "url": "https://example.com/policy"
  },
  "termsOfUse": {
    "url": "https://example.com/policy"
  },
  "imprint": {
    "url": "https://example.com/policy"
  }
}

Response

Returns the updated group.

bannerImageIdstring ObjectId

The banner image of the group. Ensure that given media is an image with the proper size (at least 980px wide and 370px high).

backgroundImageIdstring ObjectId

The background image of the group. Ensure that given media is an image with the proper size (at least 760px wide and 880px high).

faviconImageIdstring ObjectId

The favicon image of the group. Ensure that given media is an image with the proper size (less than 500px wide and 500px high and more than 16px wide and 16px high).

logoImageIdstring ObjectId

The logo image of the group.

subdomainstring

The subdomain of the group.

urlstring

The custom url of the group. The given URL must resolve on the same address as 360learning.com.

_idstring ObjectId required

The unique ID of the group.

namestring required

The name of the group.

customstring

A custom field to store information available only in the General settings of the group, the CSV exports, and the API. This information is not displayed to learners on the platform.

publicboolean required

True if the group is public; false if the group is private.

parentIdstring ObjectId

The unique ID of the parent group. Not defined for the root group.

Example response

{
  "privacyPolicy": {
    "url": "https://example.com/policy"
  },
  "moderationCharter": {
    "url": "https://example.com/policy"
  },
  "termsOfUse": {
    "url": "https://example.com/policy"
  },
  "imprint": {
    "url": "https://example.com/policy"
  },
  "bannerImageId": "507f1f77bcf86cd799439011",
  "backgroundImageId": "507f1f77bcf86cd799439011",
  "faviconImageId": "507f1f77bcf86cd799439011",
  "logoImageId": "507f1f77bcf86cd799439011",
  "subdomain": "company-subdomain",
  "url": "company-domain.com",
  "_id": "507f1f77bcf86cd799439011",
  "name": "Engineering Team",
  "custom": "Unit 101",
  "parentId": "507f1f77bcf86cd799439011"
}

Changes

  • d827a4a84180Revision changes
    • breaking

      added subschema #1: Custom Url Dns Not Configured to the response body oneOf list for the response status