Skip to Content
InvyteDocs
Jobs & workflows

Check a workflow design for a Job

See what a Job's workflow would be if it started from a template, the Job's own draft or live workflow, or blank, with these step changes, and every problem that would stop it being assigned or published. Nothing is saved.

POST
/operations/workflows.checkDesign

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/workflows.checkDesign' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string",    "base": {      "kind": "template",      "templateId": "string"    }  }}'
Example Response
{  "status": "done",  "output": {    "jobId": "string",    "baseRevision": 0,    "steps": [      {        "id": "string",        "type": "string",        "kind": "string",        "title": "string",        "config": {          "property1": null,          "property2": null        },        "parentId": "string"      }    ],    "connections": [      {        "from": "string",        "to": "string",        "branch": "string"      }    ],    "ruleFields": [      {        "stepId": "string",        "field": "string",        "label": "string",        "type": "string",        "description": "string",        "numeric": {          "min": 0,          "max": 0,          "step": 0,          "displayScale": 0,          "unit": "percent"        },        "options": [          {            "value": "string",            "label": "string"          }        ]      }    ],    "addedStepIds": [      "string"    ],    "problems": [      {        "stepId": "string",        "message": "string"      }    ],    "publishProblems": [      {        "stepId": "string",        "message": "string"      }    ]  },  "actionId": "string"}

Assign a Job's workflow POST

Check the unpublished Job's workflow draft and make it the workflow candidates will go through once the Job is published.

Copy another Job's workflow POST

Start a Job's workflow draft as a copy of another Job's current workflow. Settings that belong to the other Job are left to set up again. Replacing an existing draft (replaceDraft) loses it for good, so that shows what is lost and waits for your go-ahead.