Jump to

• Request
• Response

Updates a group user mapped item

put

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/Users/{userId}

Request

Supported Media Types

• application/json

Path Parameters

• groupId: number
  Unique identifier of a Group.
• learnCenterId: number
  Unique identifier of LearnCenter.
• userId: number
  Unique identifier of a user.

Body ()

Group mapped item object that needs to be updated.

Root Schema : GroupUserMappedItemRequest

Type: object

Request Payload for creating group user mapping.

Show Source

• ExcludeFlag: boolean
  You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group.

  Example: true

{
    "description":"Request Payload for creating group user mapping.",
    "type":"object",
    "required":[
        "ExcludeFlag"
    ],
    "properties":{
        "ExcludeFlag":{
            "description":" You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group.",
            "type":"boolean",
            "example":true
        }
    },
    "example":{
        "ExcludeFlag":true
    }
}

Example:

{
    "ExcludeFlag":true
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

updated a mapping of group to an item.

400 Response

Request has incorrect syntax or does not contain a field that is required.

409 Response

Another resource with the same identifier already exists.

500 Response

Internal server error.

Back to Top