Create Invite - User Intuition

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": "participant@example.com", "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": "participant@example.com", "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", "study_type": "standard", "chat_welcome_message": "Hi! I'm ready to start our conversation. How are you today?", "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

Authenticate with an API key (prefixed ui_sk_) or a JWT token from the dashboard.

Body

application/json

assistant_id

string

required

The assistant ID to associate with the invite

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

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

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

screener_questions

object[] | null

Array of screener questions from the assistant

Show child attributes

concept_image

any | null

Single concept image for concept test studies

study_type

string | null

Study type: standard or human_signal

is_concept_test

boolean | null

Whether this study includes concept test image display

language

string | null

Language code from the assistant's voice config

chat_welcome_message

string | null

Translated chat welcome message based on the study language