Skip to main content
POST
Send draft packages

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.

Body

application/json
packageIds
string[]
required

The ids of the draft packages to send. At least one.

Minimum array length: 1

The id of a draft package.

Minimum string length: 1
Example:

Response

Success

data
object
required