Skip to Content
InvyteDocs

Preview publishing a Job's workflow draft

Before publishing a live Job's workflow draft: each step change against the current workflow and against each older version candidates are still on, and which current candidates could move onto it and why the others can't.

POST
/operations/workflows.previewPublish

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.previewPublish' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "jobId": "string",    "draftRevision": 0,    "changes": [      {        "field": "string",        "label": "string",        "from": null,        "to": null      }    ],    "olderVersions": [      {        "workflowId": "string",        "name": "string",        "candidateCount": 0,        "changes": [          {            "field": "string",            "label": "string",            "from": null,            "to": null          }        ]      }    ],    "candidates": [      {        "applicationId": "string",        "name": "string",        "canMove": true,        "invites": true,        "reason": "string"      }    ],    "movableCount": 0,    "invitesCount": 0,    "excludedCount": 0  },  "actionId": "string"}