Skip to main content
POST
Pin a site to the member's menu

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.

Body

application/json

The site to pin to the member's menu. Any other field is refused as an unknown field.

site_id
string<uuid>
required

Public id of the site, as listed in the member's menu.

Response

The site was already pinned. The existing pin.

One pin.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

A member's pin of one site in their menu.

meta
object
required

Envelope metadata present on every response.