applicationFeedback.submit

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 value
  • CompensationRange - An object in the format { type: "compensation-range", minValue: 100000, maxValue: 150000, currencyCode: "USD", interval: "1 YEAR" }. currencyCode must be a valid ISO 4217 code and interval must be a valid compensation interval (e.g. "1 HOUR", "1 YEAR").
  • Currency - An object in the format { value: 100000, currencyCode: "USD" }. currencyCode must be a valid ISO 4217 code.
  • Date - A date string in the format YYYY-MM-DD
  • Email - A valid email address
  • LongText, Phone, String - A string
  • MultiValueSelect - An array of strings that exist in the MultiValueSelect field's selectable options
  • Number - An integer
  • NumberRange - 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 } where score is an integer between 1 and 4 inclusive. Optionally include comments as 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:

  1. Call file.createFileUploadHandle with fileUploadContext: "ApplicationFeedbackImage", the filename, image MIME type and exact size in bytes. Supported images may be up to 50 MiB.
  2. POST the image directly to the returned url as multipart/form-data. Include every returned fields entry before the file part. The upload URL expires after 10 minutes.
  3. Include the returned handle directly 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 same X-On-Behalf-Of user when applicable.
  4. Submit the feedback with richTextFormat: "text/html" to receive permanent image markup inside submittedValues. 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum

The representation of RichText answers and Score comments in submittedValues. When supplied, rich values are returned as { type: richTextFormat, value: string }. Other values are unchanged. Omit this to use the endpoint's default response representation.

Allowed:
feedbackForm
object
required

The application feedback form data containing field submissions

uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The feedback form to submit. For interview feedback, this must be the form assigned to the interview.

uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The application to submit feedback for. For interview feedback, this must match the interview's application.

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The id of the user the feedback will be credited to. If omitted, the feedback will be credited to the API key user.

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The interview event to submit feedback for. Requires userId to identify the interviewer. If their feedback already exists, it is updated. Otherwise, it is created. Omit this to create a separate feedback submission.

Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json