Update a group

Update all fields of an existing group.

SecurityAPIKeyHeader
Request
path Parameters
id
required
string
Request Body schema:
required
description
string or null [ 1 .. 1024 ] characters
external_id
required
string [ 1 .. 128 ] characters
name
required
string [ 1 .. 255 ] characters
parent
string or null non-empty
status
string (StatusEnum)
  • ACTIVE - ACTIVE
  • INACTIVE - INACTIVE
Enum: "ACTIVE" "INACTIVE"
Responses
200
Response Schema: application/json
created_at
string <date-time>
created_by_user_id
string
description
string or null <= 1024 characters
external_id
required
string <= 128 characters
id
string
name
required
string <= 255 characters
parent
string or null
status
string (StatusEnum)
  • ACTIVE - ACTIVE
  • INACTIVE - INACTIVE
Enum: "ACTIVE" "INACTIVE"
updated_at
string <date-time>
updated_by_user_id
string or null
put/groups/{id}/
Request samples
{
  • "description": "string",
  • "external_id": "string",
  • "name": "string",
  • "parent": "string",
  • "status": "ACTIVE"
}
Response samples
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "created_by_user_id": "string",
  • "description": "string",
  • "external_id": "string",
  • "id": "string",
  • "name": "string",
  • "parent": "string",
  • "status": "ACTIVE",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "updated_by_user_id": "string"
}
Copyright © Shipwell 2025. All right reserved.