Other

PATCH /v1/email/automation-settings

PATCH /v1/email/automation-settings

Required scopes: communications:write

patch/v1/email/automation-settings

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/email/automation-settings
  • Auth: HTTP bearer

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

auto_send_acknowledgmentboolean
auto_send_advancementboolean
auto_send_interview_confirmationboolean
auto_send_rejectionboolean
auto_send_offerboolean
candidate_sender_namestring nullable
candidate_reply_to_emailstring email nullable
quiet_hours_startinteger
quiet_hours_endinteger

Response

Success

object required

Changes

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