workspaces

Invite somebody by email (owner only)

Only the person signed in with that address can accept it. A pending invitation holds a seat.

post/workspaces/{id}/invitations

Request

  • Base URL: https://api.swingfactor.ai/v1
  • URL: https://api.swingfactor.ai/v1/workspaces/{id}/invitations
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The workspace's id (a UUID).

Headers

Idempotency-Keystring

Any unique string. The same key, method, path and body within 24 hours answers with the first response instead of creating again; the same key on a different request is 409 idempotency_key_reused.

Request body

emailstring email required
role'editor' | 'viewer' required

Response

The invitation.

idstring uuid required
containerIdstring uuid required
emailstring required
tokenstring required
role'editor' | 'viewer' required
createdAtstring required
expiresAtstring required

Changes

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