Create a DM automation default reply in Hive from a saved reply. Setting it active is refused for an account that still needs reconnecting or provider approval.

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/create_default_reply

Request

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

Headers

Idempotency-Keystring

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

Request body

namestring required

What to call this default reply.

savedReplyIdstring required

The saved reply whose words it sends.

accountIdsstring[] required

The connected Hive accounts it answers on.

status'paused' | 'active' | 'draft'

Active starts answering real people on the next message. Paused stops replies; draft is a legacy alias for paused.

keywordModestring

How the words are matched, when it watches for words at all.

keywordsstring[]

The words it watches for.

firstContactOnlyboolean

Answer only the first message from a person.

businessHoursModestring

When it is allowed to answer.

timezonestring

The time zone the hours are read in.

cooldownMinutesnumber

Minutes before the same person can be answered again.

maxSendsPerThreadnumber

How many times one conversation may be answered.

handoffAfterSendboolean

Hand the conversation to a person after answering.

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.