VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Analytics
Api_keys
Auth
Component_dev_sessions
Component_registry
Components
Development
Events
Experiments
Feature_flag_overrides
Feature_flag_targets
Feature_flags
Ingest_policy
Notification_sends
Notifications
Organizations
Payment_provider_configurations
Payment_provider_products
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Users
Webhooks
Analytics
Event capture
List Perks
Create Perk
Get Perk
Update Perk
Delete Perk

Update Perk

PATCH
/api/v1/perks/{perkId}

Path Parameters

perkId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string|null
slug?string|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v1/perks/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "projectId": "string",  "slug": "string"}
{  "_tag": "Api/SdkValidationError",  "message": "string"}
{  "_tag": "Api/AuthenticationError",  "cause": "string",  "message": "string"}
{  "_tag": "Api/ActionForbiddenError",  "message": "string"}
{  "_tag": "Api/PerkNotFoundError",  "message": "string"}
{  "_tag": "Api/PerkSlugAlreadyExistsError",  "slug": "string"}
{  "_tag": "Api/PerkServiceError",  "cause": "string"}
PreviousGet PerkNextDelete Perk