Skip to main content
POST
Share a record with a group

Authorizations

Authorization
string
header
required

Human personal access token (sk-actrl-pat-...).

Headers

Idempotency-Key
string

Stable key for safely retrying this write. Reuse the same key only with the same request body; results are retained for 24 hours and conflicting reuse returns 409.

Path Parameters

id
string
required

Body

application/json

dekVersion and sourceWrappedDek are required whenever wrappers for users other than the caller are written. Empty/actor-only groups persist intent without key material.

groupId
string<uuid>
required

Group receiving access.

wrappers
object[]
required
dekVersion
integer

Record DEK version read before opening its source wrapper.

Required range: x >= 1
sourceWrappedDek
object

Exact encrypted source wrapper opened by the client; never plaintext key material.

sourceProjectKeyVersion
integer

Required only when the source is the project copy; omit for an individual wrapper.

Required range: x >= 1
materialOnly
boolean

Repair only missing wrappers of an existing grant; never creates or restores a group grant.

Response

Record shared with the group.

ok
enum<boolean>
required
Available options:
true
data
object
required