Skip to main content
POST
/
workspace
/
invitations
Error
A valid request URL is required to generate request examples
{
  "status": "ok",
  "data": {
    "user_id": 42,
    "display_name": "John Doe",
    "email": "admin@timelines.ai",
    "role": "owner",
    "team": "Default",
    "status": "Active",
    "created_at": "2026-02-22 00:00:00 +0100",
    "invitation_status": "Expired",
    "whatsapp_accounts": [
      {
        "id": "972501111111@s.whatsapp.net",
        "phone": "+972540000001",
        "connected_on": "2023-06-18 15:19:23 +0100",
        "status": "Active",
        "owner_name": "John Doe",
        "owner_email": "john.doe@acme.com",
        "account_name": "John Doe"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

A JSON object describing the invitation.

​
email
string
required

Email address of the user to invite

Example:

"newuser@example.com"

​
first_name
string

First name for the invited user

Example:

"John"

​
last_name
string

Last name for the invited user

Example:

"Doe"

​
team_title
string

Title of the team to assign the invited user to, default "Default team"

Example:

"Sales"

​
role
enum<string>

Role to assign. One of: collaborator, teammate, admin, agent, team_supervisor. Case-insensitive.

Available options:
admin,
team_supervisor,
teammate,
agent,
collaborator
Example:

"agent"

Response

Success

​
status
enum<string>
required
Available options:
ok,
error
Example:

"ok"

​
data
object
required