Workspaces

Create a workspace invitation

post/workspaces/{id}/invitations

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/workspaces/{id}/invitations
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Workspace ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

emailstring email required

Email address to invite

role'admin' | 'editor' | 'client' | 'viewer' required

Workspace role to grant

Example request

{
  "$schema": "https://example.com/api/v1/schemas/CreateWorkspaceInvitationInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

accept_urlstring

Browser URL that accepts the invitation

accepted_atstring

When the invitation was accepted

accepted_by_user_idstring

Accepting user ID

created_atstring required

Invitation creation time

emailstring required

Invited email

email_delivery_status'created' | 'queued' | 'sent' | 'delivered' | 'failed' | 'unavailable' required

Truthful transport outcome for the latest Transactional invitation email. Sent means provider accepted; Delivered requires an authenticated callback.

email_delivery_updated_atstring

Provider callback time for the latest terminal delivery outcome

expires_atstring required

Invitation expiry time

idstring required

Invitation ID

invited_by_user_idstring required

Inviting user ID

last_sent_atstring required

When the invitation was most recently sent

revoked_atstring

When the invitation was revoked

rolestring required

Workspace role to grant

status'created' | 'queued' | 'sent' | 'delivered' | 'delivery_failed' | 'delivery_unavailable' | 'expired' | 'revoked' | 'accepted' required

Current invitation lifecycle, with terminal invitation state taking precedence over email delivery state

workspace_idstring required

Workspace ID

Example response

{
  "$schema": "https://example.com/api/v1/schemas/WorkspaceInvitationResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.