Nurture Campaigns

Update nurture campaign

Updates an existing nurture campaign. Pass all steps — mark removed steps with is_deleted=true.

put/nurture-campaigns/{id}

Request

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

Path parameters

idinteger required

Resource ID (numeric).

Request body

titlestring required

Campaign name

workflow_idinteger

Workflow ID this campaign is associated with.

stage_idinteger

Pipeline 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

Timezone for scheduled sends (e.g. America/New_York).

send_to_allboolean

Whether to send to all candidates or only new ones.

response_move_to_stage_idinteger

Stage ID to move candidates to when they respond.

Response

Updated 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.