Kombo · Schema

PutAtsApplicationsApplicationIdStageRequestBody

ATSEmbedded iPaaSHRISLMSPayrollUnified API

Properties

Name Type Description
stage_id string The Kombo ID of the stage to move the application to. This stage must be allowed for the job that the application is connected to. Get available stages from the `stages` property on the job, not from
remote_fields object Additional fields that we will pass through to specific ATS systems.
View JSON Schema on GitHub

JSON Schema

kombo-putatsapplicationsapplicationidstagerequestbody-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PutAtsApplicationsApplicationIdStageRequestBody",
  "title": "PutAtsApplicationsApplicationIdStageRequestBody",
  "type": "object",
  "properties": {
    "stage_id": {
      "type": "string",
      "description": "The Kombo ID of the stage to move the application to. This stage must be allowed for the job that the application is connected to. Get available stages from the `stages` property on the job, not from the deprecated application-stages endpoint."
    },
    "remote_fields": {
      "allOf": [
        {
          "type": "object",
          "properties": {
            "workday": {
              "type": "object",
              "properties": {
                "Workflow_Step_ID": {
                  "type": "string",
                  "description": "The Workflow_Step_ID to pass directly to the Move_Candidate request. When provided, the automatic workflow step matching logic is skipped."
                },
                "Step_Type": {
                  "type": "string",
                  "enum": [
                    "Next_Step_Reference",
                    "Disposition_Step_Reference"
                  ],
                  "description": "The type of step reference to use. Use \"Next_Step_Reference\" for regular stage moves and \"Disposition_Step_Reference\" for conclusion/disposition stages (e.g., rejected, declined). Defaults to \"Next_Step_Reference\"."
                }
              },
              "description": "Fields specific to Workday."
            }
          },
          "description": "Additional fields that we will pass through to specific ATS systems."
        },
        {
          "type": "object",
          "properties": {
            "greenhouse": {
              "type": "object",
              "properties": {
                "post_headers": {
                  "type": "object",
                  "properties": {
                    "On-Behalf-Of": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "ID of the the user that will show up as having performed the action in Greenhouse. We already pass a value by default, but you can use this to override it."
                    }
                  },
                  "description": "Headers we will pass with `POST` requests to Greenhouse."
                }
              },
              "description": "Fields specific to Greenhouse."
            },
            "workable": {
              "type": "object",
              "properties": {
                "on_behalf_of_user_remote_id": {
                  "type": "string",
                  "description": "The remote ID of the user that will be displayed in the UI as the one that performed the action."
                }
              },
              "description": "Workable specific remote fields for ATS actions."
            }
          },
          "description": "Additional fields that we will pass through to specific ATS systems."
        }
      ],
      "description": "Additional fields that we will pass through to specific ATS systems."
    }
  },
  "required": [
    "stage_id"
  ]
}