Skip to main content
POST
A pending invitation to the caller's verified email, in any workspace.

Authorizations

Authorization
string
header
required

A user session token or personal API key.

Headers

Connect-Protocol-Version
number
required

Define the version of the Connect protocol

Example:

1

Connect-Timeout-Ms
number

Define the timeout, in ms

Example:

1000

Body

application/json
name
string

Response

Success

An offer to join a workspace, addressed to an email address that may have no account yet.

name
string
workspace
string
email
string
Maximum string length: 254
role
enum<string>

ROLE_ADMIN or ROLE_MEMBER.

Available options:
ROLE_UNSPECIFIED,
ROLE_OWNER,
ROLE_ADMIN,
ROLE_MEMBER
inviter
string
createTime
string<date-time>

A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (Z); input may use an offset from UTC.

Example:

"2023-01-15T01:30:15.01Z"

expireTime
string<date-time>

cf. AIP-214.

Example:

"2023-01-15T01:30:15.01Z"

workspaceDisplayName
string

The workspace's name, for an invitee who cannot read the workspace yet.

cf. Member.display_name.