Skip to main content
PATCH
/
v1
/
groups
/
{id}
Update a group
curl --request PATCH \
  --url https://api.scrip.dev/v1/groups/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Updated Team Name"
}
'
{
  "created_at": "2024-01-15T10:30:00Z",
  "deleted_at": "2023-11-07T05:31:56Z",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Sales Team",
  "status": "ACTIVE",
  "updated_at": "2024-01-15T10:30:00Z"
}
Updates mutable fields on a group, such as its name. Only the fields you include in the request body are changed; omitted fields remain untouched. Archived groups cannot be updated. Archiving is permanent; there is no unarchive operation.
For usage patterns and examples, see the Groups guide.

Authorizations

​
X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

​
id
string<uuid>
required

Group ID

Body

application/json

Fields to update

​
name
string

New display name for the group (1-255 chars)

Required string length: 1 - 255
Example:

"Updated Team Name"

Response

Updated group

​
created_at
string<date-time>

When this group was created

Example:

"2024-01-15T10:30:00Z"

​
deleted_at
string<date-time>

When the group was archived (present only if archived)

​
id
string<uuid>

Unique identifier for this group

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string

Display name of the group

Example:

"Sales Team"

​
status
string

Lifecycle status: ACTIVE or ARCHIVED

Example:

"ACTIVE"

​
updated_at
string<date-time>

When this group was last updated

Example:

"2024-01-15T10:30:00Z"