Create a group

Creates a group on the Mindtickle platform with a name, and returns the group ID.

View as Markdown

Prerequisites

Authentication and setup: A valid access token.

Endpoint

POST /services/data/v2.0/mtobjects/Group

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

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

Request

Parameter	Type	Required	Description
`name`	string	Required	Group name, from 3 to 50 characters. Missing, empty, shorter, or longer names return HTTP 400.

Request example

{
  "name": "APAC Sales"
}

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 created.
`group.name`	string	Name of the group.
`group.id`	string	Mindtickle ID of the group.

Response example

{
  "requestId": null,
  "responseCode": 0,
  "responseType": "GROUP",
  "taskCompleted": true,
  "group": {
    "name": "APAC Sales",
    "id": "1234567890123456101"
  }
}