The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.
Dev guideRecipesAPI ReferenceChangelog
Dev guideAPI ReferenceRecipesChangelogUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Delete a Holdout

Permanently and irreversibly delete a holdout by its unique ID. This is a destructive operation that cannot be undone.

⚠️ CAUTION - Permanent Deletion:

  • All holdout configuration data will be permanently lost
  • Associated metric data will be deleted from MetricsHub
  • Experiment rules and historical data will be removed
  • There is no way to recover this data after deletion

What gets deleted:

  • Holdout configuration (traffic allocation, audience conditions, etc.)
  • All associated experiment rules and their settings
  • Metric tracking data and historical performance
  • System metadata and lifecycle timestamps

Safer Alternative - Archiving: If you want to stop a holdout without permanent data loss, consider archiving instead:

  1. Update the holdout status to concluded (if currently running)
  2. Use the PATCH endpoint to set archived: true

Archived holdouts preserve all historical data while removing them from active lists and preventing further modifications.

When to use DELETE vs ARCHIVE:

  • DELETE: Use only when you're certain the holdout and all its data should be permanently removed
  • ARCHIVE: Recommended for most cases - preserves data for analysis while cleaning up active experiments

Important Notes:

  • Can delete holdouts in any status (draft, running, concluded)
  • Operation affects both database and MetricsHub systems
  • This corresponds to the delete_url link in holdout responses
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The project identifier

integer
required

The holdout identifier

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
204

Successfully deleted the holdout. No response body is returned.

Deletion completed:

  • Holdout configuration permanently removed from database
  • Associated metrics deleted from MetricsHub
  • All experiment rules and historical data destroyed
  • Holdout is no longer accessible via any API endpoints

What happens after deletion:

  • GET requests to this holdout will return 404 Not Found
  • The holdout will not appear in list responses
  • Associated URLs (update_url, fetch_url, etc.) become invalid
  • Any references to this holdout in other systems should be cleaned up

A successful 204 response confirms the holdout has been completely removed from all systems.

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json