flows

Share a flow with a guest

Gives one person access to this flow only — they see its progress and nothing else in the workspace.

post/v1/flows/{flowId}/shares

Request

  • Base URL: https://api.flowral.app
  • URL: https://api.flowral.app/v1/flows/{flowId}/shares
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (client credentials, token URL https://api.flowral.app/v1/oauth/token, scopes: flows:write)

Path parameters

flowIdstring required

Request body

emailstring required
rolestring

viewer or commenter.

Response

CREATED

idstring required
emailstring email required
role'viewer' | 'commenter' required
flowIdstring required
createdAtstring date-time

Changes