Nurture Campaigns

Create nurture campaign

Creates a new nurture campaign with steps. Optionally bind to a workflow stage via workflow_id and stage_id.

post/nurture-campaigns

Request

  • Base URL: https://api.100hires.com/v2
  • URL: https://api.100hires.com/v2/nurture-campaigns
  • Auth: HTTP bearer

Request body

company_idinteger

Target company ID (optional if API key is scoped to one company)

titlestring required

Campaign name

workflow_idinteger

Workflow ID to bind the campaign to

stage_idinteger

Stage ID that triggers the campaign

delay_timeinteger

Delay before the first step, in seconds (0–86400). Takes precedence over relative_days + relative_time when both are sent.

relative_daysinteger

Days after the trigger for the first step. Used together with relative_time.

relative_timeinteger

Time of day for the first step, in seconds from midnight (0–86400). Used together with relative_days.

timezonestring

IANA timezone, e.g. "America/New_York"

send_to_allboolean

Send to all candidates or only new ones

response_move_to_stage_idinteger

Stage to move candidate to when they reply

Response

Created nurture campaign

idinteger

Campaign ID

typestring

Always "nurture_campaign"

titlestring

Campaign name

url_backofficestring uri

Absolute backoffice URL to edit this nurture campaign in the 100Hires recruiter app. Use to render deep-links in agent UIs.

send_to_allboolean

Whether to send to all candidates or only new ones

response_move_to_stage_idinteger nullable

Stage ID to move candidate when they reply

Example response

{
  "type": "nurture_campaign",
  "url_backoffice": "https://app.100hires.com/settings/nurture-campaigns/edit?id=42"
}

Changes

No recorded changes to this operation across all 1 revision of this API.