Access and gates
set_paid_access_requirements
Set who may BUY one offer and what they answer first. email_access and buyer_fields are FULL REPLACEMENTS; an allowlist with zero entries is refused because it would make the offer unbuyable. Omit buyer_fields to keep the current questions, [] to ask nothing. Leaves the purchase password (set_paid_access_password) and the classic site gate (set_gate_access) untouched. Editor role.
Behaviour
- Effect
- Destructive. It can remove or overwrite existing data.
- Repeat calls
- Idempotent. Repeating the same call produces the same result.
- Plan
- Pro plan required (Paid Access).
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_id | string | Yes | Unique mutation ID. Reuse only to replay identical arguments. |
| site_id | uuid | Yes | Site UUID from list_sites. |
| offer_id | uuid | Yes | Offer UUID from get_paid_access. |
| email_access | object | Yes | Who may buy, by email. 'none' lets anyone buy; 'allowlist' restricts purchase to verified owners of matching emails and FULLY REPLACES the approved-email list. Zero entries is refused (unbuyable offer). |
| buyer_fields | array of object | No | FULL REPLACEMENT of the pre-checkout questions. Max 6; [] asks nothing. Types: short_text, dropdown (needs options[]), checkbox, email, phone. Keys are unique lowercase snake_case. |
Returns
| Name | Type |
|---|---|
| site_id | string |
| offer_id | string |
| email_access_mode | enum none | allowlist |
| approved_email_count | integer |
| buyer_field_count | integer |
| purchase_password_set | boolean |
| idempotency_replay | false |
Using it
set_paid_access_requirements is called by an AI assistant connected to Sentway over MCP, not by hand. Point the assistant at the Sentway MCP endpoint and complete the OAuth flow, and the tool becomes available in the same session as the other 56 Sentway tools. See connecting over MCP.