Skip to main content
POST
/
api
/
invites
Create Invite
curl --request POST \
  --url https://api.userintuition.ai/api/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "[email protected]",
  "company_name": "Example Corp",
  "name": "Jane Smith",
  "study_id": "study-123",
  "issilent": false,
  "istest": false
}
'
{
  "id": "invite-new-id-123",
  "assistant_id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "[email protected]",
  "company_name": "Example Corp",
  "name": "Jane Smith",
  "user_id": "user_123",
  "app_id": "user-intuition",
  "study_id": "study-123",
  "issilent": false,
  "istest": false,
  "isuniversal": false,
  "is_reward_sent": false,
  "assistant_name": "Customer Feedback Assistant",
  "created_at": "2024-01-15T15:00:00Z",
  "updated_at": "2024-01-15T15:00:00Z",
  "sent_at": "2024-01-15T15:00:05Z"
}

Authorizations

​
Authorization
string
header
required

Enter your JWT token. You can obtain this from your User Intuition dashboard.

Body

application/json
​
assistant_id
string
required

The assistant ID to associate with the invite

​
email
string<email> | null

Email address of the person being invited

​
company_name
string | null

Company name

​
name
string | null

Name of the person being invited

​
app_id
string | null

App ID - defaults to user-intuition if not provided

​
study_id
string | null

Optional study ID to associate with the invite

​
issilent
boolean
default:false

Whether to skip sending the invitation email

​
istest
boolean
default:false

Whether this is a test invite

​
isuniversal
boolean
default:false

Whether this is a universal invite

Response

Invite created successfully

​
id
string
required

Database primary key ID

​
assistant_id
string
required

The assistant ID

​
created_at
string<date-time>
required

Timestamp when the invite was created

​
updated_at
string<date-time>
required

Timestamp when the invite was last updated

​
email
string<email> | null

Email address associated with the invite

​
company_name
string | null

Company name associated with the invite

​
name
string | null

Name of the person being invited

​
user_id
string | null

User ID associated with the invite

​
app_id
string | null

App ID associated with the invite

​
study_id
string | null

Optional study ID associated with the invite

​
issilent
boolean
default:false

Whether the invite is silent (no email sent)

​
istest
boolean
default:false

Whether the invite is a test

​
isuniversal
boolean
default:false

Whether the invite is universal

​
is_reward_sent
boolean
default:false

Whether the reward has been sent

​
reward_sent_at
string<date-time> | null

Timestamp when the reward was sent

​
sent_at
string<date-time> | null

Timestamp when the invite email was sent

​
assistant_name
string | null

Name of the associated assistant

​
vapi_assistant_id
string | null

VAPI assistant ID

​
call_status
string<date-time> | null

Call status timestamp

​
enable_video_recording
boolean | null

Whether video recording is enabled

​
enable_chat
boolean | null

Whether chat is enabled