Enroll a contact in a Hive sequence
enroll_contact_in_sequenceDestructiveIdempotent
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.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| contactId | Yes | The Hive contact identity to enroll. | |
| sequenceId | Yes | The published Hive sequence. | |
| approvalToken | No | Single-use token returned by Hive after the owner approves this exact action. | |
| entryEventKey | Yes | 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. | |
| idempotencyKey | Yes | A caller-generated unique key (8-200 characters). Reuse it only when retrying this exact write. | |
| expectedVersion | Yes | The positive currentVersion from read_sequence whose publishedDocument the person reviewed. |