Remove a pin
Removes one end user's pin in an environment, so they see what the location shows everyone else again.
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_....
The end user, as {identityType}:{identityValue} with the value percent-encoded, such as email:alice@example.com. The type is person_id, distinct_id or email.
^(?:person_id|distinct_id|email):[\s\S]*?$Query parameters
The environment the pin is for: production, the default, which answers every app, or test, which answers apps using a test key only and wins there.
Value in
- "production"
- "test"
Examples
curl -X DELETE "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/paywall-locations/pw_loc_e2r5t8y1u4i7o0p3a6s9d2f5/pins/email:ada@example.com" \ -H "Authorization: Bearer vh_sk_..."{ "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": "paywall_location_pin_not_found", "message": "Paywall location pw_loc_m4x1c6v8b3n5q0w2e7h7d2k9 has no production pin for email \"ada@example.com\".", "param": "identity" }}{ "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
Errors
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | paywall_location_pin_not_found | When there is none. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Paywall locations
- List paywall locations
GET - Create a paywall location
POST - Retrieve a paywall location
GET - Update a paywall location
PATCH - Archive a paywall location
POST - Place a paywall at a location
PUT - End a location's placement
DELETE - List what a location has shown
GET - List a location's pins
GET - Pin an end user to a paywall
PUT - List a location's rules
GET - Replace a location's rules
PUT
Something wrong or missing on this page? Tell us by email or on Discord.