Skip to main content
POST
Add signing group members

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

Choose people by user id, email address, or both. At least one is required and at most 100 per call across both lists. Each person must be an active member of the workspace: if anyone is not, the call fails and nobody is added.

userIds
string[]

User ids of workspace members to add. Combined with emails, at most 100 per call.

Maximum array length: 100

A workspace member's user id.

Minimum string length: 1
emails
string<email>[]

Email addresses of workspace members to add. Combined with userIds, at most 100 per call.

Maximum array length: 100

A workspace member's email address. Matched case-insensitively.

Response

Success

data
object
required