Archive a paywall

Archives a paywall.

Locations showing it keep showing its deployed build, and unarchive restores it. Archiving an archived paywall changes nothing.

Guide: Paywalls in your app

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Paywalls

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousDelete a paywall NextUnarchive a paywall

On this page

Authorization Path parameters Examples Response body Errors More in Paywalls

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

paywallId*string

The paywall's id, pw_....

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls/pw_h7d2k9m4x1c6v8b3n5q0w2e7/archive" \  -H "Authorization: Bearer vh_sk_..."

{  "id": "pw_h7d2k9m4x1c6v8b3n5q0w2e7",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Annual upsell",  "slug": "annual-upsell",  "kind": "paywall",  "isArchived": true,  "archivedAt": "2026-04-20T10:00:00.000Z",  "thumbnailUrl": null,  "createdAt": "2026-02-20T16:42:10.000Z",  "updatedAt": "2026-03-10T11:03:27.000Z"}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Archive a paywall

Errors

More in Paywalls

Archive a paywall

Errors

More in Paywalls

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Archive a paywall

Archive a paywall

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`