Skip to Content
InvyteDocs

Nudge a candidate

Email a candidate about their next step on this Job, in your words or Invyte's. Only when a Nudge is due: not while one is waiting, after they unsubscribed, or once the Job is closed.

POST
/operations/pipeline.nudge

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?
replay?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/pipeline.nudge' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "applicationId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "notificationId": "string",    "kind": "next_step_reminder",    "sendsAt": "2019-08-24T14:15:22Z",    "undoUntil": "2019-08-24T14:15:22Z",    "held": true  },  "replay": {    "notificationId": "string"  },  "actionId": "string"}