Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Application

application.change_stage

Deprecated. Use application.changeStage instead.

Change the stage of an application.

Requires the candidatesWrite permission.

post/application.change_stage

Request body

applicationIdstring uuid required

The id of the application to update the stage of.

interviewStageIdstring uuid required

The interview stage to move the application to.

archiveReasonIdstring uuid nullable

Archive Reason to set when moving to an Interview Stage with type Archived. Required when moving to an Archived stage.

Example request

{
  "applicationId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "interviewStageId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "archiveReasonId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "archiveEmail": {
    "communicationTemplateId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
  }
}

Response

Responses from the application.change_stage endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-16T10:30:00.000Z",
    "status": "Active",
    "customFields": [],
    "candidate": {
      "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
      "name": "Michael Bluth",
      "primaryEmailAddress": {
        "value": "michael@bluth.example",
        "type": "Personal",
        "isPrimary": true
      },
      "primaryPhoneNumber": null
    },
    "currentInterviewStage": {
      "id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "title": "Application Review",
      "type": "PreInterviewScreen",
      "orderInInterviewPlan": 1,
      "interviewStageGroupId": null,
      "interviewPlanId": "d3f4762e-1234-4abc-9876-aabbccddeeff"
    },
    "source": null,
    "archiveReason": null,
    "archivedAt": null,
    "job": {
      "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
      "title": "First Designer",
      "locationId": null,
      "departmentId": null
    },
    "creditedToUser": null,
    "hiringTeam": [],
    "appliedViaJobPostingId": null,
    "submitterClientIp": null,
    "submitterUserAgent": null
  }
}