Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Survey Submission

surveySubmission.create

Creates a survey submission for a candidate and application.

Requires the candidatesWrite permission.

post/surveySubmission.create

Request body

surveyFormDefinitionIdstring uuid required

The unique identifier of the survey form definition to submit

candidateIdstring uuid required

The unique identifier of the candidate submitting the survey

applicationIdstring uuid required

The unique identifier of the associated application

submittedValuesobject required

A map of form field paths to submitted values

Example request

{
  "surveyFormDefinitionId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "candidateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "submittedValues": {
    "_systemfield_name": "Gob Bluth"
  }
}

Response

Responses from the surveySubmission.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "surveyFormDefinitionId": "49e621fa-b342-413a-b876-5d924689c23b",
    "submittedAt": "2026-05-21T02:02:17.342Z",
    "candidateId": "d13f3430-d0de-4305-b41c-444d02f19954",
    "applicationId": "38fdb18a-5753-48e0-8a55-d8a124c346b2",
    "surveyType": "CandidateExperience",
    "formDefinition": {
      "sections": [
        {
          "fields": [
            {
              "isRequired": false,
              "field": {
                "id": "cb539763-33a2-4172-a915-dc14d9120671",
                "type": "NPSRating",
                "path": "_systemfield_overall_candexp_rating",
                "humanReadablePath": "",
                "title": "How likely are you to recommend us to others?",
                "isNullable": false
              }
            }
          ]
        }
      ]
    },
    "submittedValues": {
      "_systemfield_overall_candexp_rating": "5"
    }
  }
}