Set up a recurring Hive email delivery for one saved report: who receives it, how often and in which format. Your AI asks you before this runs; with Hive approvals on, Hive asks again inside Hive, because it sends email on its own afterwards.

This reaches real people, so the person is asked before it runs. Their own AI client asks them. When the connection was made with Hive approvals switched on, the first call returns a single-use Hive approval link instead of acting, and the exact request is repeated with approvalToken and an Idempotency-Key once they approve it inside Hive.

post/api/v1/tools/schedule_report_email

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/schedule_report_email
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Required on the approved retry; optional while requesting the initial approval challenge.

Request body

reportIdstring required

The Hive report id.

cadence'daily' | 'weekly' | 'monthly' required

How often it is sent.

format'csv' | 'xlsx' | 'pdf' | 'ppt'

Which file is attached. Defaults to pdf.

timezonestring

IANA time zone the send time is read in.

sendTimestring

Local send time as HH:MM.

dayOfWeekinteger

0 to 6, for a weekly cadence.

dayOfMonthinteger

1 to 28, for a monthly cadence.

internalRecipientIdsstring[]

Hive member ids who receive it.

externalRecipientsstring[]

Email addresses outside the workspace. These need the plan feature for outside delivery and the owner’s approval.

externalRecipientsApprovedboolean

Set true only when the person has approved sending outside the workspace.

approvalTokenstring

Single-use token returned by Hive after the owner approves this exact action.

Response

Tool result or approval challenge

OR

Changes

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