Skip to main content
POST
Attach library documents to a package

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
documentIds
string[]
required

The library documents to link, from 1 to 50, appended to the package's documents in this order. Each library role is filled by the recipient with the same role name. A linked document keeps the fields placed on it in the library, and PUT /api/v1/packages/:packageId/fields can't change them.

Required array length: 1 - 50 elements

The id of a library document, from GET /api/v1/library/documents. A document that has been trashed is a 404.

Minimum string length: 1

Response

Success

data
object
required