Yapper Docs
Api reference
POST
/sessions/{sessionId}/access/invites

Adds an existing workspace member directly, preserving their workspace role. A new person is invited as a project-only guest by default. Only workspace owners and admins can invite guest editors. Workspace roles and seat limits still apply.

Authorization

bearerAuth sharing:write
AuthorizationBearer <token>

In: header

Scope: sharing:write

Path Parameters

sessionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/sessions/string/access/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "role": "admin"  }'
{  "data": {    "status": "pending",    "email": "user@example.com",    "workspaceRole": "guest",    "sessionId": "string",    "role": "admin"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}