Skip to main content
PATCH
Change a share's permission

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session and portal JWTs are read-only and are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

id
string<uuid>
required

Id of one of the site's shares.

Body

application/json

The change to a share. Only the permission changes; to change who a share names, delete it and add another.

permission
enum<string>
required

What the audience may do with the site.

Available options:
view,
copy

Response

The changed share.

One share.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

One audience a site is shared with. It never carries an email address.

meta
object
required

Envelope metadata present on every response.