Skip to Content
InvyteDocs

Email people about a Job

Send one message, with {first name} filled in, to up to 25 people for a Job: applicants get it as a Nudge, Talent Hub people (by the key `talent.list` gave, an Invyte Network person's `person_v1.…` key included) with their Add to Job email, which asks them first unless they said yes to roles like this, Sourcing prospects with an invitation to apply. It goes from your connected mailbox when you use one (at most 300 a day and 30 a minute; the rest wait), else from Invyte with replies to you. People who can't be emailed are skipped with the reason. Each Nudge comes back with its notificationId and undoUntil: pipeline.undoNudge calls it back until then. The review lists each email with its recipient as given.

POST
/operations/outreach.send

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/outreach.send' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "jobId": "string",    "message": {      "subject": "string",      "body": "string"    },    "recipients": [      {        "applicationId": "string"      }    ]  }}'
Example Response
{  "status": "done",  "output": {    "results": [      {        "recipient": "string",        "status": "sent",        "kind": "next_step_reminder",        "reason": "string",        "notificationId": "string",        "undoUntil": "2019-08-24T14:15:22Z"      }    ]  },  "replay": {    "results": [      {        "recipient": "string",        "status": "sent",        "kind": "next_step_reminder",        "notificationId": "string"      }    ]  },  "actionId": "string"}