Put one person into the exact published Hive sequence version they reviewed. Read publishedDocument and currentVersion with read_sequence first. This queues real messages to an eligible person, so your AI asks before this runs; with Hive approvals on, Hive asks again inside Hive. A changed publication requires a new review. Contacts without live consent are recorded as stopped_opt_out and receive no messages.

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

Request

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

Headers

Idempotency-Keystring

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

Request body

sequenceIdstring required

The published Hive sequence.

expectedVersioninteger required

The positive currentVersion from read_sequence whose publishedDocument the person reviewed.

contactIdstring required

The Hive contact identity to enroll.

entryEventKeystring required

A caller-generated key of 8 to 180 characters naming why this person is being enrolled. The same key never enrolls the same person twice.

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.