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 perks
Create a perk
Retrieve a perk
Update a perk
Delete a perk

Create a perk

Creates a perk.

Guide: Perks

POST
/api/v1/projects/{projectId}/perks

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.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

name*string

The perk's name.

slug*string

How SDKs check access to the perk, unique in the project, such as premium.

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/perks" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "name": "Premium",    "slug": "premium"  }'
{  "id": "perk_c4v7b1n9m2x5z8q3w6e0r4t7",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Premium",  "slug": "premium"}
{  "error": {    "type": "invalid_request",    "code": "invalid_body",    "message": "The request body is invalid: Missing key\n  at [\"name\"]"  }}
{  "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": "perk_slug_taken",    "message": "Another perk in this project already uses the slug \"premium\".",    "param": "slug"  }}
{  "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
409conflictperk_slug_takenWhen the slug is in use.

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

More in Perks

  • List perks GET
  • Retrieve a perk GET
  • Update a perk PATCH
  • Delete a perk DELETE

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

PreviousList perksNextRetrieve a perk

On this page

AuthorizationPath parametersRequest bodyExamplesResponse bodyErrorsMore in Perks