Skip to main content
POST
/
workspaces
/
invitations
Invite member
curl --request POST \
  --url https://app2.freyavoice.ai/api/v2/workspaces/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "role": "member",
  "message": "<string>"
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "invitation": {
        "id": "<string>",
        "workspaceId": "<string>",
        "inviterId": "<string>",
        "email": "[email protected]",
        "role": "<string>",
        "status": "<string>",
        "token": "<string>",
        "expiresAt": "<string>",
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "acceptedAt": "<string>",
        "inviterEmail": "<string>",
        "inviterDisplayName": "<string>"
      },
      "emailWarning": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
workspaceId
string<uuid>
required

Workspace ID

email
string<email>
required

Email address to invite

role
enum<string>
default:member

Role to assign: member or admin

Available options:
member,
admin
message
string

Optional invitation message

Maximum string length: 500

Response

Invitation sent

success
enum<boolean>
required
Available options:
true,
false
data
object
required