Modify the groups associated with the user

Prev Next
Put
/v2/Teams/{userId}/groups
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Path parameters
userId
stringRequired

The ID of the team account

Body parameters
Team Account -Edit associated user groups.

Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}
object
associated_groups
Array of string Required

An array of group IDs in which the team account is associated.

string
is_invitation_id
boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}
object
associated_groups
Array of string Required

An array of group IDs in which the team account is associated.

string
is_invitation_id
boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}
object
associated_groups
Array of string Required

An array of group IDs in which the team account is associated.

string
is_invitation_id
boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Team Account -Edit associated user groups.

Here you can add or remove the existing associated groups of the user. To update an SSO user who hasn't logged into the system, you can pass the invitation ID as userId and in the body set is_invitation_id to true.

{
  "associated_groups": [
    "2e29fa1a-37db-4d15-b06b-0261c60d1898",
    "y529fa1a-gedb-4d15-b76b-0261c60d87t8"
  ],
  "is_invitation_id": true
}
object
associated_groups
Array of string Required

An array of group IDs in which the team account is associated.

string
is_invitation_id
boolean

Applicable only for SSO team accounts. If temporary invitation ID is passed as team account ID, then set this to true.

Responses
200

Success

Successfully updated associated groups

Updated the group accociated with the user.

{
  "result": true,
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}
Expand All
object
result
boolean

Customer API response data

extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

associated_groups not found

kindly check the associated_groups id from /V2/Teams/Groups.

{
  "extension_data": null,
  "success": true,
  "errors": [
    {
      "extension_data": null,
      "stack_trace": null,
      "description": "The AssociatedGroups field is required.",
      "error_code": "400",
      "custom_data": null
    }
  ],
  "warnings": [],
  "information": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.