Skip to main content
POST
/
v1
/
api
/
surfaces
/
{id}
/
visibility
Set surface visibility
curl --request POST \
  --url https://api.hq.zone/v1/api/surfaces/{id}/visibility \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "visibility": "<string>"
}
'
{
  "auth_mode": "<string>",
  "surface_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "visibility": "<string>"
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

id
string<uuid>
required

Surface id

Body

application/json
visibility
string
required

"private" or "public".

Response

Visibility updated

auth_mode
string
required
surface_id
string<uuid>
required
visibility
string
required