Skip to content
Mindtickle Developer DocsBeta

Try searching for

↑↓ to navigate↵ to openesc to close
Dark mode

Update a group

Updates an existing group on Mindtickle by group ID.

View as Markdown(opens in a new tab)
Use with AI

Open this page in

ChatGPT(opens in a new tab)Claude(opens in a new tab)Cursor(opens in a new tab)

Prerequisites

  1. Authentication and setup: A valid access token.
  2. Create a group: The group must exist.

Endpoint

Section titled “Endpoint”
PUT /services/data/v2.0/mtobjects/Group/GROUP_ID

Base URL: the standard REST host for your region. See Base URLs.

Headers: Authorization: Bearer ACCESS_TOKEN, Content-Type: application/json.

Path parameters

Section titled “Path parameters”
Parameter Type Required Description
GROUP_ID string Required Mindtickle ID of the group.

Request

Section titled “Request”
Parameter Type Required Description
name string Not specified New name of the group. Include it when renaming a group.

Request example

Section titled “Request example”
{
  "name": "APAC Sales Enablement"
}

Response

Section titled “Response”
Field Type Description
requestId string or null Request identifier. The response examples return null.
responseCode integer Special response codes from the server.
responseType string Type of response from the server.
taskCompleted boolean Completion flag for this request. This endpoint returns its result directly.
group Group Information on the group you have updated.
group.name string Name of the group.
group.id string Mindtickle ID of the group.

Response example

Section titled “Response example”
{
  "requestId": null,
  "responseCode": 0,
  "responseType": "GROUP",
  "taskCompleted": true,
  "group": {
    "name": "APAC Sales Enablement",
    "id": "1234567890123456101"
  }
}

Errors

Section titled “Errors”
Status Error Reason
400 Bad Request group with name NAME already present A group already has the requested name. This also applies when the supplied name is the current name of the group being updated.

If the group already has the desired name, skip the rename request. If an earlier request has an uncertain outcome, get the group and check its name before retrying.