Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application Feedback

applicationFeedback.submit

Application feedback forms support a variety of field types.

The values accepted for each field depend on the type of field that's being filled out:

  • 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 - We do not support submitting rich text documents via the API but we do support submitting plain text values for these fields. Plain text values must be submitted in the format { type: "PlainText", value: "A plain text string" }
  • Score - An object in the format { score: 4 } where score is an integer between 1 and 4 inclusive. Optionally include comments as plain text: { score: 4, comments: { type: "PlainText", value: "A plain text string" } }. Comments are returned in the same PlainText shape in submittedValues.
  • 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

The submittedValues field in the response contains the submitted feedback in an object where the key is the path of the field and the value is the value submitted for that field.

Requires the candidatesWrite permission.

post/applicationFeedback.submit

Request body

formDefinitionIdstring uuid required

The id of the feedback form definition associated with the form submission

applicationIdstring uuid required

The id of the application you're submitting feedback for

userIdstring uuid nullable

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

interviewEventIdstring uuid nullable

The id of the interview event you're submitting feedback for

Example request

{
  "formDefinitionId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "userId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "interviewEventId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the applicationFeedback.submit endpoint

OR

Example response

{
  "success": true,
  "results": {
    "submittedFormInstance": {
      "id": "0209ec12-0611-4c74-8b86-2cce35acfc46",
      "formDefinition": {
        "sections": [
          {
            "fields": [
              {
                "isRequired": true,
                "field": {
                  "id": "dbf36925-0161-4f40-8a04-fcb49e5bbdb0",
                  "type": "ValueSelect",
                  "path": "overall_recommendation",
                  "humanReadablePath": "Overall Recommendation",
                  "title": "Overall Recommendation",
                  "isNullable": false,
                  "selectableValues": [
                    {
                      "label": "4 - Strong Yes",
                      "value": "4"
                    },
                    {
                      "label": "3 - Yes",
                      "value": "3"
                    },
                    {
                      "label": "2 - No",
                      "value": "2"
                    },
                    {
                      "label": "1 - Strong No",
                      "value": "1"
                    }
                  ]
                }
              }
            ]
          }
        ]
      },
      "submittedValues": {
        "overall_recommendation": "3"
      }
    }
  }
}