Skip to main content
PATCH
/
api
/
interviews
/
rooms
/
{room_id}
Update Room
curl --request PATCH \
  --url https://app.aseed.ai/custdev/api/interviews/rooms/{room_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "research_goals_override": "<string>",
  "interview_guide_override": "<string>",
  "topics_for_respondent": "<string>",
  "max_duration_minutes": 123,
  "expires_at": "2023-11-07T05:31:56Z",
  "clear_research_goals_override": false,
  "clear_interview_guide_override": false,
  "clear_topics_for_respondent": false,
  "display_name": "<string>",
  "clear_display_name": false
}
'
{
  "id": "<string>",
  "project_id": "<string>",
  "access_token": "<string>",
  "url": "<string>",
  "room_name": "<string>",
  "max_duration_minutes": 123,
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "record_id": "<string>",
  "respondent_email": "<string>",
  "research_goals_override": "<string>",
  "interview_guide_override": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "voice": "<string>",
  "realtime_provider": "<string>",
  "language": "<string>",
  "topics_for_respondent": "<string>",
  "display_name": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

room_id
string<uuid>
required

Body

application/json

Request model for updating an interview room.

research_goals_override
string | null
interview_guide_override
string | null
topics_for_respondent
string | null
max_duration_minutes
integer | null
expires_at
string<date-time> | null
clear_research_goals_override
boolean
default:false
clear_interview_guide_override
boolean
default:false
clear_topics_for_respondent
boolean
default:false
display_name
string | null
Maximum string length: 42
clear_display_name
boolean
default:false

Response

Successful Response

Response model for interview room details.

id
string
required
project_id
string
required
access_token
string
required
url
string
required
room_name
string
required
max_duration_minutes
integer
required
status
string
required
created_at
string<date-time>
required
created_by
string
required
record_id
string | null
respondent_email
string | null
research_goals_override
string | null
interview_guide_override
string | null
started_at
string<date-time> | null
finished_at
string<date-time> | null
expires_at
string<date-time> | null
voice
string | null
realtime_provider
string | null
language
string | null
topics_for_respondent
string | null
display_name
string | null
Maximum string length: 42