Update a paywall location
Changes a location's name or description; description: null clears it.
The slug cannot change, because apps ask for the location by it.
Guide: Paywalls in your app
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
The location's id, pw_loc_....
Request body
application/json
TypeScript definitions
Use the request body type in TypeScript.
The new name.
The new description; null clears it.
Examples
curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "description": "The Upgrade row in the app\'s settings." }'{ "id": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Settings upgrade", "slug": "settings-upgrade", "description": "The Upgrade row in the app's settings.", "isArchived": false, "archivedAt": null, "showing": { "id": "pw_loc_show_w4e8r2t6y0u3i7o1p5a9s3d7", "paywallLocationId": "pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5", "type": "paywall", "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7", "buildNumber": 3, "featureFlagId": null, "startedAt": "2026-03-10T11:05:02.000Z", "endedAt": null, "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1" }, "createdAt": "2026-02-20T16:45:31.000Z", "updatedAt": "2026-03-11T09:12:00.000Z"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Expected object" }}{ "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.