workspaces
workspaces

Create Invite

Invite someone to the workspace.

Requires manage_members permission. Provide either email (for external users) or user_id (for existing users).

post/api/workspaces/{workspace_id}/invites

Request

  • Base URL: https://api.dialogbrain.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dialogbrain.com/api/workspaces/{workspace_id}/invites
  • Auth: none declared

Path parameters

workspace_idinteger required

Request body

emailstring email nullable
user_idinteger nullable
rolestring
metadataobject nullable

Optional member metadata, e.g. PMS role and unit IDs

Response

Successful Response

idinteger required
workspace_idinteger required
emailstring nullable required
usernamestring nullable required
user_idinteger nullable required
rolestring required
tokenstring nullable
created_atstring nullable required
expires_atstring nullable required
invited_by_namestring nullable required
invited_by_emailstring nullable required
email_sentboolean nullable

Changes

No recorded changes to this operation across all 5 revisions of this API.