Archive a paywall location
Archives a location and ends what it shows, so apps asking for it get no paywall.
Archiving an archived location changes nothing.
Guide: Paywalls in your app
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.
paywallLocationId*string
The location's id, pw_loc_....
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/archive" \ -H "Authorization: Bearer vh_sk_..."{ "id": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Settings upgrade", "slug": "settings-upgrade", "description": null, "isArchived": true, "archivedAt": "2026-04-20T10:00:00.000Z", "showing": null, "createdAt": "2026-02-20T16:45:31.000Z", "updatedAt": "2026-04-20T10:00:00.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." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
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 Paywall locations
Something wrong or missing on this page? Tell us by email or on Discord.