VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List paywalls
Create a paywall
Retrieve a paywall
Update a paywall
Delete a paywall
Archive a paywall
Unarchive a paywall
List a paywall's builds
Build a paywall
Retrieve a paywall build
Deploy a paywall build

Build a paywall

Starts building the paywall's current design in the background and answers 202 with the build building; read it with getBuild until it is ready or failed, then deploy it.

Only a person can start a build, because a build records who started it.

Guide: Paywalls in your app

POST
/api/v1/projects/{projectId}/paywalls/{paywallId}/builds

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_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

documentVersion?|

The design version you reviewed; when the design has changed since, nothing is built. Omitted, the current design is built.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywalls/pw_h7d2k9m4x1c6v8b3n5q0w2e7/builds" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "documentVersion": 41  }'
{  "id": "pw_build_k3v8n1q6x2c9m4h7d5b0w8e2",  "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7",  "number": 3,  "status": "building",  "documentVersion": 41,  "isDeployed": false,  "deployedAt": null,  "flowPackage": null,  "failure": null,  "createdByUserId": "user_k3m8q1z6v9c2x5b7n4w0e8r1",  "createdAt": "2026-03-10T11:03:30.000Z",  "finishedAt": null}
{  "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": "person_credential_required",    "message": "Only a person can do this; project secret keys cannot."  }}
{  "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_document_changed",    "message": "The paywall changed after version 12; it is at version 14 now. Review it and build that version.",    "param": "documentVersion"  }}
{  "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

StatustypecodeWhen
403permission_deniedperson_credential_requiredFor a project secret key.
409conflictpaywall_document_changedWhen the design has changed since the documentVersion given; nothing is built then.

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
  • Retrieve a paywall build GET
  • Deploy a paywall build POST

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

PreviousList a paywall's buildsNextRetrieve a paywall build

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Paywalls