Update a payment page

Changes a payment-page pattern or turns it off with enabled: false. Only the fields you send are changed, and reconciliation runs again afterwards.

Requires the manager role on the website and the compliance plan feature.

Authorization

AuthorizationBearer <token>

An OpenID Connect access token issued by Keycloak, acting as the signed-in user.

In: header

Path Parameters

workspaceId*string

websiteId*string

pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Only the fields you send are changed.

name?string

New display name.

Length1 <= length <= 255

urlPattern?string

New pattern to match page URLs against.

Length1 <= length <= 1024

patternType?|

How urlPattern is read. glob uses * wildcards and is the default. regex is a regular expression, kept for existing integrations.

enabled?boolean

Turn the pattern on or off.

Response Body

`application/json`

curl -X PATCH "https://api-next.centralcsp.com/v1/workspaces/string/websites/string/compliance/payment-pages/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "workspaceId": "string",  "websiteId": "string",  "name": "Checkout",  "urlPattern": "https://shop.example.com/checkout/*",  "patternType": "glob",  "enabled": true,  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z"}