Campaigns
Delete Campaign
Delete a campaign and all associated data including promotions, store associations, and historical records.
DELETE
This endpoint permanently removes a campaign and all its associated data from the system. This includes promotions, store associations, usage statistics, and historical performance data.
Campaign deletion is irreversible. All associated promotions will be deactivated immediately, and historical data will be permanently lost. Consider archiving campaigns instead of deletion for data retention.
Path Parameters
The unique identifier of the company that owns the campaign
The unique identifier of the campaign to delete
Query Parameters
Current local date for audit and timezone purposes (e.g., “Nov 15 2024 03:46:34”)
Force deletion even if campaign has active promotions or associations
Whether to create an archive backup before deletion
Response
Indicates whether the deletion was successful
Confirmation message or error details
The ID of the deleted campaign
Timestamp when the deletion occurred
Summary of what was deleted along with the campaign
Location where archived data was stored (if archive_data=true)
Response Example
Deletion Process Workflow
Deletion Process Workflow
When a campaign is deleted, the following occurs in sequence:
- Validation: Verify deletion permissions and campaign status
- Promotion Deactivation: Immediately stop all active promotions
- Store Disassociation: Remove campaign from all associated stores
- Data Archival: Create backup of all campaign data (if enabled)
- Record Deletion: Remove campaign and related records from active database
- Cache Invalidation: Clear all cached campaign data across systems
- Audit Logging: Record deletion event for compliance and tracking
Data Archival: By default, campaign data is archived before deletion. This allows for potential data recovery and historical analysis while removing the campaign from active systems.
Alternative to Deletion: Consider setting campaign status to “inactive” or “archived” instead of deletion to preserve historical data while removing the campaign from customer-facing systems.
Pre-Deletion Checks
Deletion Safety Checks
Deletion Safety Checks
Active Promotions Check
- Verifies if campaign has active promotions
- Warns about customer impact of immediate deactivation
- Requires force_delete=true to proceed with active promotions
- Identifies all stores currently using the campaign
- Estimates impact on store operations
- Provides list of affected store locations
- Calculates amount of historical data that will be lost
- Estimates analytics impact
- Recommends archival before deletion
- Identifies other campaigns that reference this campaign
- Checks for integration dependencies
- Verifies no business-critical dependencies exist
Use Cases
Common Deletion Scenarios
Common Deletion Scenarios
Campaign Cleanup
- Remove test or duplicate campaigns
- Clean up failed campaign launches
- Eliminate outdated promotional campaigns
- Delete campaigns containing expired promotional content
- Remove campaigns with data privacy concerns
- Comply with data retention policies
- Remove campaigns that are causing system issues
- Clean up campaigns with corrupted data
- Eliminate campaigns that are no longer relevant
- Delete campaigns from discontinued product lines
- Remove campaigns from closed store locations
- Eliminate campaigns that don’t align with new business strategy
Error Responses
Common Error Scenarios
Common Error Scenarios
Campaign Not FoundActive Promotions Prevent DeletionInsufficient PermissionsDependency Conflict
Immediate Impact: Campaign deletion immediately affects all customer-facing systems. Active promotions will stop working instantly, which may impact customer experience and pending orders.
Recovery Options
Post-Deletion Recovery
Post-Deletion Recovery
Archive Recovery
- Archived data can be restored within 30 days
- Requires administrative approval
- May not restore all system integrations
- System backups may contain campaign data
- Recovery requires technical intervention
- Data consistency cannot be guaranteed
- Campaign settings can be manually recreated
- Historical performance data will be lost
- Promotions and associations must be rebuilt