Skip to main content
PUT
Save a package document's fields

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

packageId
string
required

Body

application/json
documentId
string
required

The document whose fields to change. It must be attached to the package or template in the path; any other document is a 404.

Minimum string length: 1
Example:

"cmg1p4k2a0007v9x0d8n3f5t2"

ops
object[]
required

The changes to apply, in order, as one transaction: if any operation fails, none is kept. An empty list is accepted and changes nothing.

Response

Success

data
object
required