Pin an end user to a paywall
Pins one end user, {identityType}:{identityValue} in the path, to a paywall at the location: they see its deployed build there whatever the location shows everyone else, and are outside an A/B test running there.
Replaces the end user's pin in that environment, answering 201 when there was none. A production pin answers every app; a test pin answers apps using a test key only and wins there. A pin shows only where the location shows something in that environment.
Guide: Paywalls in your app
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_identity | For an identity that is blank or longer than 255 characters. |
| 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. |
| 409 | conflict | paywall_location_pin_limit | When the location already holds 200 pins. |
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 - Remove a pin
DELETE - 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.