Update discovery interview

PATCH /api/v3/discovery_interviews/{id}

The request and response builder is not available for this endpoint. See the OpenAPI specification for complete parameters and schemas.

Request fields

Send only the fields you want to change inside a JSON record object. This applies to both PUT and PATCH.

Only writable fields for this endpoint are listed. Required flags reflect the endpoint schema; record and workspace validation also applies.

Search request fields

Field	Type	Response field
Name of the record.	string	`name`
Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "name": "example" } }`
Date and time when the interview starts.	date-time	`start_time`
Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "start_time": "2026-01-01T00:00:00Z" } }`
Date and time when the interview ends.	date-time	`end_time`
Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "end_time": "2026-01-01T00:00:00Z" } }`
Status of the interview.	string	`status`
Allowed values: `schedulingscheduledprocessinganalyzingcompletedcanceled` Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "status": "scheduling" } }`
Mode of the interview.	string	`mode`
Allowed values: `in_personphonevideofocus_groupobservationdocument_analysis` Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "mode": "in_person" } }`
ID of the study containing the interview.	string	`study`
Submit `study_id`; the response includes `study`. Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "study_id": "123" } }`
ID of the type of interview.	string	`interview_type`
Submit `interview_type_id`; the response includes `interview_type`. Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "interview_type_id": "123" } }`
Custom field values to set. Property names are custom field definition keys, and each value is one of the supported input formats below, depending on the field type. Attachment fields are read-only and can't be set.	object	`custom_fields`
Use your account’s custom field API keys and values matching each field’s type. Example field fragment (replace placeholder values and include any other required fields): `{ "record": { "custom_fields": { "your_key": "example" } } }`

Response fields

Choose which fields to include in the response. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.

Search fields

Field	Type	Returned by default
Unique record ID.	integer	Yes
Return this field: `fields=id`
URL to view the record in Aha!	string	Yes
Return this field: `fields=html_url`
API URL for the record.	string	Yes
Return this field: `fields=url`
Name of the record.	string	Yes
Return this field: `fields=name`
Reference number of the record.	string	Yes
Return this field: `fields=reference_num`
Date and time when the record was created.	date-time	No
Return this field: `fields=created_at`
Date and time when the record was last updated.	date-time	No
Return this field: `fields=updated_at`
Date and time when the interview starts.	date-time	No
Return this field: `fields=start_time`
Date and time when the interview ends.	date-time	No
Return this field: `fields=end_time`
Status of the interview.	string	No
Return this field: `fields=status` Allowed values: `schedulingscheduledprocessinganalyzingcompletedcanceled`
Mode of the interview.	string	No
Return this field: `fields=mode` Allowed values: `in_personphonevideofocus_groupobservationdocument_analysis`
Summary of the interview.	string	No
Return this field: `fields=summary`
Sentiment analysis of the interview.	DiscoverySentiment	No
Return this field: `fields=sentiments` Expand this association to browse its response fields. Select subfields with `fields=sentiments[title,sentiment]`.
Workspace that contains the record.	Project	No
Return this field: `fields=project` Expand this association to browse its response fields. Select subfields with `fields=project[id,html_url]`.
Study containing the interview.	DiscoveryStudy	No
Return this field: `fields=study` Expand this association to browse its response fields. Select subfields with `fields=study[id,html_url]`.
Type of interview.	DiscoveryInterviewType	No
Return this field: `fields=interview_type` Expand this association to browse its response fields. Select subfields with `fields=interview_type[id,name]`.
Interview transcript. To append content on update, send a TXT, VTT, or DOCX file as record[transcript] using multipart/form-data. Transcript uploads are not supported in application/json requests.	Note	No
Return this field: `fields=transcript` Expand this association to browse its response fields. Select subfields with `fields=transcript[id,body]`.
Interview participants. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=idea_users[default]). Capped at 25 records. Only available on the top-level resource.	Collection	No
Return this field: `fields=idea_users` Expand this association to browse its response fields. Select subfields with `fields=idea_users[id,url]`.
Highlights from the transcript. Omitted by default. Request the field for inline records with default sub-fields, or choose sub-fields (e.g., ?fields=annotations[default]). Capped at 25 records. Only available on the top-level resource.	Collection	No
Return this field: `fields=annotations` Expand this association to browse its response fields. Select subfields with `fields=annotations[id,type]`.
Records linked to the interview.	LinkedRecord	No
Return this field: `fields=linked_records` Expand this association to browse its response fields. Select subfields with `fields=linked_records[id,link_type]`.
Custom field values. Property names are custom field definition keys, and each value is one of the supported formats below, depending on the field type. Omitted unless requested with the fields parameter or submitted in the request. Fields with no stored value are omitted.	object	No
Return this field: `fields=custom_fields` Custom field keys depend on your account. Request `fields=custom_fields` or `fields=custom_fields.your_key`.

Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.

Response field selection

Create and update responses also include fields submitted in the record body. Submitted association IDs return their associated response fields.

Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.

See field selection for details.