Automation Rules

PATCH /v1/automation-rules/{rule_id}

Changed on

PATCH /v1/automation-rules/{rule_id}

Required scopes: automation_rules:write Assigned interviewer changes (assignment_changed) and Update scheduling (update_scheduling) belong to job rules targeting candidate interviews. The action accepts template_key (default updated_scheduling_invitation), delivery (auto_send or auto_draft_review, default review), and task: { assignee: recruiter or { user_id }, title, due_in?: { value, unit: days or hours } }. Timing is always immediate and delivery_mode mirrors action.delivery. Enabled Update scheduling rules cannot overlap steps on the same job. The recommended starter begins disabled. Saved-rule preview makes no changes and uses the current interview state; manually shared links without a recorded send cannot be detected.

patch/v1/automation-rules/{rule_id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/automation-rules/{rule_id}
  • Auth: HTTP bearer

Path parameters

rule_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

pipeline_template_idstring nullable
job_idstring nullable
needs_step_pickboolean
namestring
starter_keystring nullable
job_scope'all_compatible' | 'selected'
job_posting_idsstring[]
delivery_mode'auto_send' | 'auto_draft_review'
pipeline_stage_idstring nullable
trigger'stage_enter' | 'stage_exit' | 'step_ready' | 'booking_created' | 'booking_changed' | 'step_completed' | 'feedback_submitted' | 'all_scorecards_submitted' | 'hiring_manager_advanced' | 'hiring_manager_held' | 'interview_time' | 'assignment_changed' | 'booking_cancelled' | 'scorecard_due' | 'scorecard_overdue' | 'decision_brief_ready' | 'coaching_report_ready' | 'offer_approval_due' | 'offer_approval_escalation_due'
is_activeboolean
positioninteger nullable

Response

Success

pipeline_template_idstring nullable required
job_idstring nullable required
needs_step_pickboolean required
namestring required
starter_keystring nullable required
job_scope'all_compatible' | 'selected' required
job_posting_idsstring[] required
delivery_mode'auto_send' | 'auto_draft_review' required
pipeline_stage_idstring nullable required
trigger'stage_enter' | 'stage_exit' | 'step_ready' | 'booking_created' | 'booking_changed' | 'step_completed' | 'feedback_submitted' | 'all_scorecards_submitted' | 'hiring_manager_advanced' | 'hiring_manager_held' | 'interview_time' | 'booking_cancelled' | 'scorecard_due' | 'scorecard_overdue' | 'decision_brief_ready' | 'coaching_report_ready' | 'offer_approval_due' | 'offer_approval_escalation_due' required
is_activeboolean required
positioninteger nullable required
idstring required
object'automation_rule' required
created_atstring nullable required
updated_atstring nullable required

Changes

  • bef1d2eaaaa1Revision changes
    • warning

      added the new hiring_manager_advanced enum value to the response property for the response status

    • warning

      added the new hiring_manager_held enum value to the response property for the response status

    • info

      added the new hiring_manager_advanced enum value to the request property

    • info

      added the new hiring_manager_held enum value to the request property