Skip to main content
PATCH
/
v1
/
paywalls
/
{id}
Update a paywall
curl --request PATCH \
  --url https://api.myproceeds.xyz/v1/paywalls/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "targetUrl": "<string>",
  "targetRoute": "<string>",
  "price": "<string>",
  "currency": "USDC",
  "network": "base-sepolia",
  "networks": [
    "base-sepolia"
  ],
  "merchantWallet": "<string>",
  "timeout": 1815000,
  "headers": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "allowedMethods": [],
  "queryParams": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "enabled": true,
  "cacheRules": {}
}
'
{
  "data": {
    "id": "<string>",
    "slug": "<string>",
    "name": "<string>",
    "description": "<string>",
    "targetUrl": "<string>",
    "routePattern": "<string>",
    "price": "<string>",
    "currency": "USDC",
    "network": "base-sepolia",
    "networks": [
      "base-sepolia"
    ],
    "merchantWallet": "<string>",
    "facilitatorUrl": "<string>",
    "timeout": 123,
    "validityWindow": 123,
    "allowedMethods": [],
    "enabled": true,
    "headers": [
      {
        "key": "<string>",
        "value": "***"
      }
    ],
    "queryParams": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "serviceId": "<string>",
    "userId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-Api-Key
string
header
required

API key in format mpk_<64 hex chars>. Can alternatively be sent as Authorization: Bearer mpk_....

Path Parameters

id
string
required

Body

application/json
name
string
Required string length: 1 - 100
description
string
targetType
enum<string>
Available options:
PROXY,
ROUTE
targetUrl
string<uri>
targetRoute
string
price
string
currency
enum<string>
Available options:
USDC
network
enum<string>

Supported blockchain network identifier. The value must match the owning Service / Paywall mode: pass a testnet identifier when mode is testnet, and a mainnet identifier when mode is mainnet.

Available options:
arc-testnet,
base-sepolia,
hyperevm-testnet,
tempo-testnet,
base,
hyperevm,
tempo
Example:

"base-sepolia"

networks
enum<string>[]
Minimum array length: 1

Supported blockchain network identifier. The value must match the owning Service / Paywall mode: pass a testnet identifier when mode is testnet, and a mainnet identifier when mode is mainnet.

Available options:
arc-testnet,
base-sepolia,
hyperevm-testnet,
tempo-testnet,
base,
hyperevm,
tempo
merchantWallet
string
Pattern: ^0x[a-fA-F0-9]{40}$
fulfillmentMode
enum<string>
Available options:
PROXY,
SIGNED_URL
timeout
integer
Required range: 30000 <= x <= 3600000
headers
object[]
allowedMethods
enum<string>[]
Minimum array length: 1
Available options:
GET,
POST,
PUT,
PATCH
queryParams
object[]
enabled
boolean
cacheRules
object

Response

Updated paywall

data
object
required
meta
object
required