Skip to main content
PUT
/
api
/
invites
/
{id}
Update Invite
curl --request PUT \
  --url https://api.userintuition.ai/api/invites/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "new-email@example.com",
  "name": "New Name"
}
'
{
  "id": "<string>",
  "assistant_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "company_name": "<string>",
  "name": "<string>",
  "user_id": "<string>",
  "app_id": "<string>",
  "study_id": "<string>",
  "issilent": false,
  "istest": false,
  "isuniversal": false,
  "is_reward_sent": false,
  "reward_sent_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "assistant_name": "<string>",
  "vapi_assistant_id": "<string>",
  "call_status": "2023-11-07T05:31:56Z",
  "enable_video_recording": true,
  "enable_chat": true,
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "single_select",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true
        }
      ]
    }
  ],
  "concept_image": "<unknown>",
  "study_type": "<string>",
  "is_concept_test": true,
  "language": "<string>",
  "chat_welcome_message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.userintuition.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The invite ID

Body

application/json

Payload for updating an invite. Only email, company_name, name, and sent_at are honored by the update endpoint.

​
email
string<email> | null

Email address

​
company_name
string | null

Company name

​
name
string | null

Name of the person being invited

​
sent_at
string<date-time> | null

Timestamp the invite email was sent

Response

Updated invite

​
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

​
screener_questions
object[] | null

Array of screener questions from the assistant

​
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