Skip to main content
POST
Invite a member to a site

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 JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Body

application/json

The member to invite and the role offered. Any other field is refused as an unknown field.

member_id
string<uuid>
required

Id of a member of the company.

role
enum<string>
required

view opens the site; edit also makes the member an editor once they accept: they edit the site's drafts and its branches' files, but do not publish, share, delete or copy it.

Available options:
view,
edit

Response

The member's invitation, sent again.

One invitation to one of the member's sites.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

One invitation to one of the member's sites, as its owner sees it. It carries the invitee's email address only when the company's messaging policy shows members' emails, as the share picker does.

meta
object
required

Envelope metadata present on every response.