Skip to main content
POST
/
v1
/
teams
/
{team_id}
/
invitations
Create Invitation
curl --request POST \
  --url https://api.dataraven.io/v1/teams/{team_id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "role": "operator"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "<string>",
  "role": "viewer",
  "status": "pending",
  "user_exists": true,
  "invited_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
team_id
string<uuid>
required

Body

application/json

Schema for creating a new team invitation.

​
email
string<email>
required
​
role
enum<string>
default:operator

User roles within teams (hierarchical).

  • OWNER (4): Full control including team deletion
  • ADMIN (3): All operations except team deletion
  • OPERATOR (2): Day-to-day operations (run jobs, view logs), no setup/config
  • VIEWER (1): Read-only audit access
Available options:
viewer,
operator,
admin,
owner

Response

Successful Response

Response after creating an invitation.

​
id
string<uuid>
required
​
email
string
required
​
role
enum<string>
required

User roles within teams (hierarchical).

  • OWNER (4): Full control including team deletion
  • ADMIN (3): All operations except team deletion
  • OPERATOR (2): Day-to-day operations (run jobs, view logs), no setup/config
  • VIEWER (1): Read-only audit access
Available options:
viewer,
operator,
admin,
owner
​
status
enum<string>
required

Team invitation status values.

Available options:
pending,
accepted,
declined,
expired,
revoked
​
user_exists
boolean
required
​
invited_by
string<uuid>
required
​
created_at
string<date-time>
required
​
expires_at
string<date-time>
required