applicationFeedback.submit

Application feedback forms support a variety of field types.

Requires the candidatesWrite permission.

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 integer between 1 and 4 submitted in the format { score: 4 }
  • 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
feedbackForm
object
required
uuid
required

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

uuid
required

The id of the application you're submitting feedback for

uuid

The id of the user the feedback will be credited to. If a userId is not provided, the feedback will be credited to the API key user.

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