Update feedback

cURL

curl --request PUT \
  --url https://api.hirehive.com/v1.0/{company_id}/feedback/{feedback_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedback_id": "<string>",
  "application_id": "<string>",
  "form_id": "<string>",
  "answers": [
    {
      "question_id": "<string>",
      "text": "<string>",
      "ratings": [
        {
          "option_id": "<string>",
          "rating": 123
        }
      ],
      "selected_options": [
        "<string>"
      ],
      "selected_option": "<string>"
    }
  ]
}
'

{
  "data": {
    "questions": [
      {
        "options": [
          {
            "id": "<string>",
            "label": "<string>",
            "description": "<string>"
          }
        ],
        "id": "<string>",
        "type": "textbox",
        "question": "<string>",
        "description": "<string>",
        "required": true,
        "restricted": true,
        "display_order": 123,
        "answer": {
          "question_id": "<string>",
          "text": "<string>",
          "ratings": [
            {
              "option_id": "<string>",
              "rating": 123
            }
          ],
          "selected_options": [
            "<string>"
          ],
          "selected_option": "<string>"
        }
      }
    ],
    "id": "<string>",
    "application_id": "<string>",
    "form_id": "<string>",
    "candidate": {
      "id": "<string>",
      "name": "<string>"
    },
    "name": "<string>",
    "creator": {
      "id": "<string>",
      "name": "<string>"
    },
    "reviewer": {
      "id": "<string>",
      "name": "<string>"
    },
    "status": "pending",
    "date_created": "2023-11-07T05:31:56Z",
    "date_complete": "2023-11-07T05:31:56Z"
  }
}

PUT

v1.0

{company_id}

feedback

{feedback_id}

cURL

curl --request PUT \
  --url https://api.hirehive.com/v1.0/{company_id}/feedback/{feedback_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "feedback_id": "<string>",
  "application_id": "<string>",
  "form_id": "<string>",
  "answers": [
    {
      "question_id": "<string>",
      "text": "<string>",
      "ratings": [
        {
          "option_id": "<string>",
          "rating": 123
        }
      ],
      "selected_options": [
        "<string>"
      ],
      "selected_option": "<string>"
    }
  ]
}
'

{
  "data": {
    "questions": [
      {
        "options": [
          {
            "id": "<string>",
            "label": "<string>",
            "description": "<string>"
          }
        ],
        "id": "<string>",
        "type": "textbox",
        "question": "<string>",
        "description": "<string>",
        "required": true,
        "restricted": true,
        "display_order": 123,
        "answer": {
          "question_id": "<string>",
          "text": "<string>",
          "ratings": [
            {
              "option_id": "<string>",
              "rating": 123
            }
          ],
          "selected_options": [
            "<string>"
          ],
          "selected_option": "<string>"
        }
      }
    ],
    "id": "<string>",
    "application_id": "<string>",
    "form_id": "<string>",
    "candidate": {
      "id": "<string>",
      "name": "<string>"
    },
    "name": "<string>",
    "creator": {
      "id": "<string>",
      "name": "<string>"
    },
    "reviewer": {
      "id": "<string>",
      "name": "<string>"
    },
    "status": "pending",
    "date_created": "2023-11-07T05:31:56Z",
    "date_complete": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_id

string<string>

required

feedback_id

string<string>

required

Body

application/json

feedback_id

string<int32>

application_id

string<int32>

form_id

string<int32>

answers

object[]

Show child attributes

answers.question_id

string<int32>

The id of the question. Format qustn_1a2b3c

answers.text

string

The text answer given. Only applicable for textbox and text_area type questions

answers.ratings

object[]

The answers given for a scorecard. Only applicable for scorecard type questions

Show child attributes

answers.ratings.option_id

string<int32>

The id of the option. Format opt_1a2b3c

answers.ratings.rating

integer<int32> | null

The answers given for a scorecard option. Options: -2 (Very poor), -1 (Poor), 0 (Neutral), 1 (Good), 2 (Very good) Only applicable for scorecard type questions

answers.selected_options

string<int32>[]

One or more answers given for a multiple choice question. Only applicable for checkbox type questions

answers.selected_option

string<int32> | null

The single selected answer for a radio/dropdown question. Only applicable for radio and dropdown type questions

Response

data

object

Show child attributes

data.questions

object[]

required

Show child attributes

data.questions.options

object[]

required

Show child attributes

data.questions.options.id

string<int32> | null

The id of the option. Format opt_1a2b3c

data.questions.options.label

string

The text label of the option

data.questions.options.description

string

The text description of the option

data.questions.id

string<int32>

The id of the question. Format qustn_1a2b3c

data.questions.type

enum<string>

The type of field of the question.

Available options:

textbox,

text_area,

radio,

checkbox,

dropdown,

upload,

header,

scorecard

data.questions.question

string

The text of the question.

data.questions.description

string

The description of the question if the type is header

data.questions.required

boolean

A bool to indicate if this question is required.

data.questions.restricted

boolean

A bool to indicate if the answers to this question require the restricted permission to view.

data.questions.display_order

integer<int32>

data.questions.answer

object

Show child attributes

data.questions.answer.question_id

string<int32>

The id of the question. Format qustn_1a2b3c

data.questions.answer.text

string

The text answer given. Only applicable for textbox and text_area type questions

data.questions.answer.ratings

object[]

The answers given for a scorecard. Only applicable for scorecard type questions

Show child attributes

data.questions.answer.ratings.option_id

string<int32>

The id of the option. Format opt_1a2b3c

data.questions.answer.ratings.rating

integer<int32> | null

The answers given for a scorecard option. Options: -2 (Very poor), -1 (Poor), 0 (Neutral), 1 (Good), 2 (Very good) Only applicable for scorecard type questions

data.questions.answer.selected_options

string<int32>[]

One or more answers given for a multiple choice question. Only applicable for checkbox type questions

data.questions.answer.selected_option

string<int32> | null

The single selected answer for a radio/dropdown question. Only applicable for radio and dropdown type questions

data.id

string<int32>

The id of the feedback. Format fdbk_1a2b3c

data.application_id

string<int32>

The application id this feedback form is for. Format app_1a2b3c

data.form_id

string<int32>

The id of the form that the feedback is connected to. Format form_1a2b3c

data.candidate

object

Show child attributes

data.candidate.id

string<int32>

The candidate_id this feedback form is for. Format can_1a2b3c

data.candidate.name

string

data.name

string

The name of the form.

data.creator

object

Show child attributes

data.creator.id

string<int32>

The id of the user that created this feedback. Format usr_1a2b3c

data.creator.name

string

data.reviewer

object

Show child attributes

data.reviewer.id

string<int32>

The id of the user that completed this feedback. Format usr_1a2b3c

data.reviewer.name

string

data.status

enum<string>

The current status of the feedback indicating if it has been completed or not.

Available options:

pending,

complete

data.date_created

string<date-time>

The date that the feedback was submitted or requested.

data.date_complete

string<date-time> | null

The date that the feedback was sumitted

Complete feedback Request feedback

⌘I

Getting Started

Endpoints

Webhooks

Authorizations

Path Parameters

Body

Response