Renames a perk or changes its slug.
Guide: Perks
| Status | type | code | When |
|---|---|---|---|
| 409 | conflict | perk_slug_taken | When another perk in the project uses the slug. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
GETPOSTGETDELETESomething wrong or missing on this page? Tell us by email or on Discord.
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
The project's id, proj_.... A secret key works only in the project it belongs to.
The perk's id, perk_....
application/json
TypeScript definitions
Use the request body type in TypeScript.
The new name.
The new slug, unique in the project. Apps that check access by the old slug stop finding the perk.
curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/perks/perk_c4v7b1n9m2x5z8q3w6e0r4t7" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "name": "Premium access" }'{ "id": "perk_c4v7b1n9m2x5z8q3w6e0r4t7", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Premium access", "slug": "premium"}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Expected object" }}{ "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." }}application/json
application/json
application/json
application/json
application/json
application/json
application/json