Turns storing a built-in event on or off.
Guide: Events
| Status | type | code | When |
|---|---|---|---|
| 404 | not_found | builtin_event_not_found | For a key that names no built-in event setting. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
Something 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 built-in event setting's key: a built-in event's name, such as $screen, or revenue for the revenue events.
application/json
TypeScript definitions
Use the request body type in TypeScript.
Whether the project stores the setting's events.
curl -X PUT "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/ingest-policy/builtin-events/$screen" \ -H "Authorization: Bearer vh_sk_..." \ -H "Content-Type: application/json" \ -d '{ "isEnabled": false }'{ "key": "$screen", "name": "Screen views", "description": "Every screen the user lands on, with the previous screen and time spent there. The highest-volume built-in event.", "eventNames": [ "$screen" ], "isEnabled": false, "isDefaultEnabled": true, "isOverridden": true, "warning": null}{ "error": { "type": "invalid_request", "code": "invalid_body", "message": "The request body is invalid: Missing key\n at [\"isEnabled\"]" }}{ "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": "builtin_event_not_found", "message": "There is no built-in event setting $app_crashed.", "param": "key" }}{ "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