Messages

Create scheduled message for candidate

Creates a candidate message through mailbox scheduler. If scheduled_at is omitted, the message is scheduled for 15 minutes after creation instead of being sent immediately.

post/candidates/{id}/messages

Request

  • Base URL: https://api.100hires.com/v2
  • URL: https://api.100hires.com/v2/candidates/{id}/messages
  • Auth: HTTP bearer

Path parameters

idstring required

Candidate ID (numeric) or alias

Request body

from_account_idinteger nullable

Optional sending mail account ID. Use GET /users/{user_id}/mail-accounts to list available accounts for a user, or GET /companies/mail-accounts to list all accounts. If omitted, the API key owner's default mail account is used.

tostring[] required

Primary recipient email addresses.

ccstring[]

Carbon-copy recipient email addresses.

bccstring[]

Blind carbon-copy recipient email addresses.

subjectstring required

Email subject line.

bodystring required

Email body as HTML.

scheduled_atinteger nullable

Unix timestamp (seconds). If omitted, defaults to created time plus 900 seconds.

application_idinteger nullable

Optional application ID linked to this message.

reply_to_email_idinteger nullable

Optional mailbox message ID to reply to.

send_in_new_threadboolean

Whether to send the message as a new thread instead of replying in an existing thread.

Response

Created scheduled message

type'mailbox' required

Message channel type for scheduler-backed message endpoints.

Changes

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