Communications

PATCH /v1/email/drafts/{id}

PATCH /v1/email/drafts/{id}

Required scopes: communications:send

patch/v1/email/drafts/{id}

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/email/drafts/{id}
  • Auth: HTTP bearer

Path parameters

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

subjectstring
html_bodystring
text_bodystring nullable
from_namestring nullable
reply_tostring nullable
requested_sender_identity_idstring uuid nullable

Response

Draft saved.

idstring required
object'email_draft' required
email_type'acknowledgment' | 'advancement' | 'interview_confirmation' | 'rejection' | 'offer_declined' | 'offer' | 'hired' | 'withdrawn' | 'on_hold' | 'scorecard_nudge' | 'scorecard_escalation' | 'decision_brief' | 'prospect_outreach' | 'candidate_follow_up' | 'interview_cancellation' required
delivery_mode'auto_send' | 'auto_draft_review' nullable required

Changes

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