POST /v1/automation-rules/{rule_id}/preview
POST /v1/automation-rules/{rule_id}/preview
Required scopes: automation_rules:read, applications:read, people:read 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.
Request
- Base URL: https://api.yardstick.team
- URL: https://api.yardstick.team/v1/automation-rules/{rule_id}/preview
- Auth: HTTP bearer
Path parameters
Headers
Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.
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
Response
Resolved recipients, sender, rendered email, links and missing prerequisites for this application. Executes no action.
Changes
No recorded changes to this operation across all 1 revision of this API.