Skip to main content
POST
Create a shared-access grant

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Body

application/json
branch_id
string
required

Branch the grant unlocks. Use "master" for the base branch.

project_id
string
required

Project the grant is scoped to

starting_entity_id
string
required

Entity the view should anchor to for the recipient

view_id
string
required

CustomView.id from the project-scoped custom-views-2 registry

access_level
enum<string>
default:viewer

Capability for this shared scope. Existing share behavior is viewer.

Available options:
viewer,
writer
branch_scope
enum<string>
default:branch

How far the grant reaches from branch_id: that branch alone, it plus every branch descended from it, or every branch in the project.

Available options:
branch,
branch_and_children,
all_branches
expires_at
string | null

ISO8601 expiry. Omit for a permanent grant.

user_group_id
string

User group receiving the grant

user_id
string

External user receiving the grant

Response

201 - application/json
access_level
enum<string>
required
Available options:
viewer,
writer
branch_id
string
required
branch_scope
enum<string>
required
Available options:
branch,
branch_and_children,
all_branches
created_at
string
required
created_by_id
string | null
required
expires_at
string | null
required
first_viewed_at
string | null
required
id
string
required
preparing
boolean
required
project_id
string
required
recipient_type
enum<string>
required
Available options:
user,
user_group
starting_entity_id
string
required
user_email
string | null
required
user_group_id
string | null
required
user_group_name
string | null
required
user_id
string | null
required
view_id
string
required