Access and gates
set_paid_access_password
Set or remove the PURCHASE password for one paid access offer: buyers must type it before Stripe Checkout opens. Pass a plaintext password to require one, or null to remove the requirement. NOT the classic gate password from set_gate_access: that admits visitors to free content, this admits buyers to checkout, and setting one never sets the other. 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. |
| password | string or null | Yes | Plaintext PURCHASE password, 6..200 chars, hashed server-side and never returned. Not the classic gate password. null removes the requirement. |
Returns
| Name | Type |
|---|---|
| site_id | string |
| offer_id | string |
| purchase_password_set | boolean |
| password_required | boolean |
| idempotency_replay | false |
Using it
set_paid_access_password 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.