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 components
Upload a component module
Submit a component's source
Retrieve a component
Update a component
Delete a component
List a component's versions
Retrieve a component version
Update a component version
List component uses

Delete a component

Deletes a component: it is no longer listed and can no longer be inserted or published.

Published paywalls keep working, and a new version under the same slug brings it back.

Guide: Components

Errors

StatustypecodeWhen
404not_foundcomponent_not_found—

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

More in Components

  • List components GET
  • Upload a component module POST
  • Submit a component's source POST
  • Retrieve a component GET
  • Update a component PATCH
  • List a component's versions GET
  • Retrieve a component version GET
  • Update a component version PATCH
  • List component uses GET

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

PreviousUpdate a componentNextList a component's versions

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Components
DELETE
/api/v1/projects/{projectId}/components/{componentId}

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.

componentId*string

The component's id, cmp_....

Examples

curl -X DELETE "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/components/cmp_p4z7c1x9v3b8n2m6q5w0e4r7" \  -H "Authorization: Bearer vh_sk_..."
Empty
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "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": "component_not_found",    "message": "This project has no component cmp_p4z7c1x9v3b8n2m6q5w0e4r7.",    "param": "componentId"  }}

{  "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