Skip to Content
InvyteDocs

Plan a Job's Mandate

Record a new revision of the Job's plan: a target (shortlisted candidates and a date), the strategy a review chose, or a requirement change with its cause and what was rerun. Changes nothing a candidate or client sees.

POST
/operations/mandates.plan

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/mandates.plan' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "jobId": "string",    "target": {      "shortlisted": 1,      "by": "2019-08-24T14:15:22Z",      "source": "plan"    },    "pipeline": {      "contacted": 0,      "consented": 0,      "applied": 0,      "inProgress": 0,      "shortlisted": 0,      "hired": 0    },    "rates": {      "contactedToConsented": {        "value": 0,        "observed": 0,        "n": 0,        "default": 0      },      "consentedToApplied": {        "value": 0,        "observed": 0,        "n": 0,        "default": 0      },      "appliedToInProgress": {        "value": 0,        "observed": 0,        "n": 0,        "default": 0      },      "inProgressToShortlisted": {        "value": 0,        "observed": 0,        "n": 0,        "default": 0      }    },    "shortfall": {      "shortlisted": 0,      "expected": 0,      "onTrack": true,      "daysLeft": -9007199254740991,      "need": {        "applicants": 0,        "contacts": 0      },      "focus": "none"    },    "owners": {      "sourcing": 0,      "communication": 0,      "pipeline": 0,      "delivery": 0,      "overridden": 0    },    "autopilot": true,    "strategy": {      "focus": "none",      "next": [        "source"      ],      "note": "string",      "at": "2019-08-24T14:15:22Z"    },    "history": [      {        "revision": 1,        "kind": "target",        "at": "2019-08-24T14:15:22Z",        "by": "string",        "target": {          "shortlisted": -9007199254740991,          "by": "2019-08-24T14:15:22Z"        },        "strategy": {          "focus": "none",          "next": [            "source"          ],          "note": "string"        },        "requirementChange": {          "summary": "string",          "cause": "client_request",          "fields": [            "string"          ],          "direction": "loosened",          "reran": []        },        "reason": "string"      }    ]  },  "actionId": "string"}