Users

Replaces the user's group memberships with the specified Group IDs.

Validation:

  • GroupIDs are required and cannot be empty.
  • All existing groups will be removed and replaced by the provided list.

Example request body:

             { "GroupIDs": [ 100, 200, 300 ] }

Responses:

  • 204 No Content: Groups replaced successfully.
  • 400 Bad Request: Missing/empty GroupIDs.
  • 401 Unauthorized: Access to the profile is not allowed.
  • 404 Not Found: User not found.
put/v1/users/{id}/groups

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/users/{id}/groups
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Path parameters

idinteger required

User ID.

Query parameters

profileidinteger

Request body

GroupIDsinteger[] required

List of group IDs. Must contain at least one ID.

Response

OK

Object required

Changes

No recorded changes to this operation across all 1 revision of this API.