Set the visibility of the bundle (REQ-084). Leaving link visibility revokes the share link.

PUT

/bundles/{bundleId}/visibility

curl --request PUT \
  --url https://example.com/api/v1/bundles/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/visibility \
  --header 'Content-Type: application/json' \
  --data '{ "visibility": "private" }'

Parameters

Path Parameters

bundleId

required

string format: uuid

Request Body^required

Media typeapplication/json

object

visibility

required

string

Allowed values: private internal link

Responses

200

The access of the bundle.

Media typeapplication/json

object

visibility

required

string

Allowed values: private internal link

authors

required

Author user IDs.

Array<string>

reviewers

required

Array<string>

share_active

required

boolean

share_expires_at

string format: date-time

can_edit

required

Whether the caller can change the bundle and its access.

boolean

Example

{
  "visibility": "private"
}

default

An error.

Media typeapplication/problem+json

RFC 9457 problem details with a stable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

instance

string

code

required

A stable machine-readable error code.

string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "code": "example"
}