Skip to main content
POST
/
projects
/
{project_reference}
/
invites
Create Project Invite
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "owner"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "role": "<string>",
  "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "invited_by": "<string>",
  "created_at": "<string>"
}

Authorizations

​
Authorization
string
header
required

Authentication via JWT token or API key. JWT: Get from Veryfront dashboard. API Key: Format "vf__" - create via /api-keys endpoint.

Path Parameters

​
project_reference
string
required

Project ID or slug

Body

application/json
​
email
string<email>
required
​
role
enum<string>
required
Available options:
owner,
admin,
editor,
viewer,
developer

Response

Invite created successfully

​
id
string<uuid>
required
​
email
string<email>
required
​
role
string
required
​
project_id
string<uuid>
required
​
invited_by
string
​
created_at
string | null