Deploy a paywall build
Deploys a ready build: every location showing the paywall shows it from now on, and deploying an older build rolls back to it.
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.
paywallId*string
The paywall's id, pw_....
buildId*string
The build's id, pw_build_....
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls/pw_h7d2k9m4x1c6v8b3n5q0w2e7/builds/pw_build_k3v8n1q6x2c9m4h7d5b0w8e2/deploy" \ -H "Authorization: Bearer vh_sk_..."{ "id": "pw_build_k3v8n1q6x2c9m4h7d5b0w8e2", "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7", "number": 3, "status": "ready", "documentVersion": 41, "isDeployed": true, "deployedAt": "2026-03-10T11:05:02.000Z", "flowPackage": { "abiVersion": 1, "productIds": [ "pro_monthly", "pro_annual" ], "sha256": "4f1c9a7e2b8d6035c1e9f4a2b7d0c8e3f6a19b5d2c7e0f8a3b6d9c1e4f7a2b5d", "url": "https://api.voidhash.com/f/4f1c9a7e2b8d6035c1e9f4a2b7d0c8e3f6a19b5d2c7e0f8a3b6d9c1e4f7a2b5d.vhfp" }, "failure": null, "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1", "createdAt": "2026-03-10T11:03:30.000Z", "finishedAt": "2026-03-10T11:03:41.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": "conflict", "code": "paywall_build_not_ready", "message": "Build pw_build_k3v8n1q6x2c9m4h7d5b0w8e2 is still building; deploy it once it is ready.", "param": "buildId" }}{ "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
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 409 | conflict | paywall_build_not_ready | While the build is building or after it failed. |
| 409 | conflict | paywall_build_components_unavailable | When a component it embeds was yanked, deprecated, deleted or uninstalled since it was built; the message names each one. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Paywalls
- List paywalls
GET - Create a paywall
POST - Retrieve a paywall
GET - Update a paywall
PATCH - Delete a paywall
DELETE - Archive a paywall
POST - Unarchive a paywall
POST - List a paywall's builds
GET - Build a paywall
POST - Retrieve a paywall build
GET
Something wrong or missing on this page? Tell us by email or on Discord.