Configure email-gate

PUT

/pages/{slug}/email-gate

Enable/disable the email-capture gate and optionally set the prompt message
(≤200 chars, sanitized) and consent requirement. Omitted fields are left
unchanged. Activating the gate requires the owner's emailCapture
entitlement (Pro+ by default); admins bypass. Disabling is always allowed.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Gate updated.

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠403Forbidden

🟠404NotFound

🟠429TooManyRequests

🔴500ServerError

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://upload.tf/api/v1/pages/mysite/email-gate' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "enabled": true,
    "message": "string",
    "consentRequired": true
}'

Response Example

200 - Example 1

{
    "success": true,
    "data": {
        "enabled": true,
        "message": "string",
        "consentRequired": true,
        "captureCount": 0
    }
}

Modified at 2026-06-26 19:58:05

Get email-gate config

Disable email-gate