Skip to main content
PATCH
Update a signing group

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-workspace-id
string

One of the workspaces the key was issued for, as returned by GET /api/v1/workspaces. Required on a key that acts for members. On any other key it is optional and omitting it acts in the key's default workspace. Any id outside the key's workspaces is rejected with 401.

x-act-as
string

Required on a key that acts for members, refused on any other key. Names the member the call runs as, as key=value: email=jane@acme.com, employee_id=E-1001, scim_external_id=… or a custom identifier. Keys are lowercase and matched case-insensitively. The call fails with 403 when no active member of the workspace matches.

Path Parameters

groupId
string
required

Body

application/json

At least one of name or description must be present.

name
string

Group name, 1 to 50 characters after trimming. Must be unique within the workspace.

Required string length: 1 - 50
description
string | null

Free-text description, up to 500 characters. Null or an empty string clears it.

Maximum string length: 500

Response

Success

data
object
required