Place a paywall at a location

Places a paywall at the location: from now on, end users see its deployed build there.

This ends the location's previous placement, even when that was a running experiment. Placing the paywall it already shows changes nothing.

Guide: Paywalls in your app

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.

paywallLocationId*string

The location's id, pw_loc_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

paywallId*string

The paywall to show, pw_...; it must have a deployed build.

Examples

curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/showing" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7"  }'

{  "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"}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"paywallId\"]"  }}

{  "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": "paywall_not_found",    "message": "This project has no paywall pw_h7d2k9m4x1c6v8b3n5q0w2e7.",    "param": "paywallId"  }}

{  "error": {    "type": "conflict",    "code": "paywall_not_deployed",    "message": "Paywall pw_h7d2k9m4x1c6v8b3n5q0w2e7 has no deployed build yet. Build it and deploy the build, then show it here.",    "param": "paywallId"  }}

{  "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`

Errors

Status	`type`	`code`	When
404	`not_found`	`paywall_not_found`	When the project has no such paywall.
409	`conflict`	`paywall_not_deployed`	When the paywall has no deployed build.
409	`conflict`	`paywall_location_archived`	When the location is archived.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Paywall locations

This ends the location's previous placement, even when that was a running experiment. Placing the paywall it already shows changes nothing.

Guide: Paywalls in your app

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.

paywallLocationId*string

The location's id, pw_loc_....

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

paywallId*string

The paywall to show, pw_...; it must have a deployed build.

Examples

curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/showing" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "paywallId": "pw_h7d2k9m4x1c6v8b3n5q0w2e7"  }'

{  "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"}

{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"paywallId\"]"  }}

{  "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": "paywall_not_found",    "message": "This project has no paywall pw_h7d2k9m4x1c6v8b3n5q0w2e7.",    "param": "paywallId"  }}

{  "error": {    "type": "conflict",    "code": "paywall_not_deployed",    "message": "Paywall pw_h7d2k9m4x1c6v8b3n5q0w2e7 has no deployed build yet. Build it and deploy the build, then show it here.",    "param": "paywallId"  }}

{  "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`

Errors

Status	`type`	`code`	When
404	`not_found`	`paywall_not_found`	When the project has no such paywall.
409	`conflict`	`paywall_not_deployed`	When the paywall has no deployed build.
409	`conflict`	`paywall_location_archived`	When the location is archived.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

Place a paywall at a location

paywall_not_found

project_not_found

paywall_not_deployed

paywall_location_archived

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

Place a paywall at a location

paywall_not_found

project_not_found

paywall_not_deployed

paywall_location_archived

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`