Update a group

Update all fields of an existing group.

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