Submit feedback for an application using the field paths and types from its feedback form. Use feedbackFormDefinition.info to read a form's fields.
Without interviewEventId, each successful call creates a separate feedback submission. To submit or edit feedback for an interviewer, provide interviewEventId and that interviewer's userId. The applicationId must match the interview, and formDefinitionId must identify the form assigned to it. If that interviewer has already submitted feedback, this updates their existing submission. Your feedback-editing settings and access permissions apply.
Provide each answer in the format required by its field type:
Boolean- A boolean valueCompensationRange- An object in the format{ type: "compensation-range", minValue: 100000, maxValue: 150000, currencyCode: "USD", interval: "1 YEAR" }.currencyCodemust be a valid ISO 4217 code andintervalmust be a valid compensation interval (e.g."1 HOUR","1 YEAR").Currency- An object in the format{ value: 100000, currencyCode: "USD" }.currencyCodemust be a valid ISO 4217 code.Date- A date string in the format YYYY-MM-DDEmail- A valid email addressLongText,Phone,String- A stringMultiValueSelect- An array of strings that exist in the MultiValueSelect field's selectable optionsNumber- An integerNumberRange- An object in the format{ type: "number-range", minValue: 1, maxValue: 10 }RichText- Plain text as{ type: "text/plain", value: "A plain text string" }, or HTML as{ type: "text/html", value: "<p><strong>Strong</strong> design.</p>" }Score- An object in the format{ score: 4 }wherescoreis an integer between 1 and 4 inclusive. Optionally includecommentsas plain text or HTML, for example{ score: 4, comments: { type: "text/html", value: "<p>Explained <em>tradeoffs</em> clearly.</p>" } }.Url- A valid URL string. The empty string is also accepted.UUID- A UUID string, or an object in the format{ value: "<uuid>" }ValueSelect- A string that matches the value of one of the ValueSelect field's selectable options
Uploading images
To include a screenshot in a RichText answer or Score comments:
- Call
file.createFileUploadHandlewithfileUploadContext: "ApplicationFeedbackImage", the filename, image MIME type and exact size in bytes. Supported images may be up to 50 MiB. - POST the image directly to the returned
urlas multipart/form-data. Include every returnedfieldsentry before the file part. The upload URL expires after 10 minutes. - Include the returned
handledirectly in HTML, for example{ type: "text/html", value: '<p>System design</p><img src="ashby-upload:YOUR_HANDLE" alt="Architecture diagram">' }. Use the same API actor for upload-handle creation and feedback submission, including the sameX-On-Behalf-Ofuser when applicable. - Submit the feedback with
richTextFormat: "text/html"to receive permanent image markup insidesubmittedValues. HTML input alone does not select HTML output.
Image bytes are uploaded separately, so screenshots can exceed the API JSON request-body limit. A handle can appear more than once in the same submission.
Editing feedback with images
When editing interview feedback that contains images, retrieve it with applicationFeedback.list and richTextFormat: "text/html", then reuse the returned HTML.
Response format
results.submittedFormInstance.submittedValues contains answers keyed by field path. By default, RichText answers and Score comments are returned as { type: "PlainText", value: "..." }.
Set richTextFormat to text/html or text/plain to receive { type: "<selected format>", value: "..." } instead. For Score values, this format applies to comments. The response format is independent of the input format and also applies to submitted values returned with form-validation errors.
Requires the candidatesWrite permission.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||

