Skip to main content
POST
Give one person, by email, access to a private page (or its whole site with --site)

Body

application/json
url
string
required

Ravi Page URL, such as https://acme.ravi.page/report

console
string

Console base URL

execute
boolean

Give the access. Without it, share prints the plan and exits 3

expires
string

End of access: 30d, 12h, 2w, or an ISO date (max 365 days)

reason
string

Why this person gets access (kept on the grant, max 500)

site
boolean

Share every private route of the page's site, not only this route

with
string

Email of the person who gets access

Response

Success — body conforms to the @Returns schema.

actedBy
object
required
consoleUrl
string
required
created
boolean
required
grant
object
required
success
boolean
required
userCreated
boolean
required