Campaigns
Update Campaign
Update an existing campaign’s configuration including name, description, schedule, and targeting parameters.
PUT
This endpoint allows you to modify existing campaign settings including basic information, scheduling, targeting criteria, and promotional parameters. Updates are applied immediately and affect all associated stores and promotions.
Campaign updates are immediately effective and will impact any active promotions or store associations. Consider the timing of updates for campaigns that are currently running.
Path Parameters
The unique identifier of the company that owns the campaign
The unique identifier of the campaign to update
Request Body
Updated campaign name
Updated campaign description
Unique campaign identifier for internal tracking
Updated campaign start time (ISO 8601 format)
Updated campaign end time (ISO 8601 format)
Updated campaign status: “active”, “inactive”, “scheduled”, “expired”
Response
Indicates whether the update was successful
Confirmation message or error details
The ID of the updated campaign
List of fields that were successfully updated
Whether changes take effect immediately
Timestamp when the update was applied
Request Example
Response Example
Update Impact Analysis
Update Impact Analysis
When a campaign is updated, the following components are affected:Immediate Changes:
- Campaign visibility in customer applications
- Promotion availability and application
- Store association effectiveness
- Marketing material display
- Start/end time modifications affect promotion windows
- Status changes immediately activate or deactivate campaigns
- Future scheduling adjustments plan automatic activation
- All associated stores receive updated campaign information
- POS systems sync new campaign parameters
- Customer-facing displays update automatically
Timing Considerations: Updates to active campaigns take effect immediately. For scheduled changes, consider creating new campaigns or using the scheduling features instead of updating active campaigns.
Version Control: The system maintains an audit trail of all campaign changes. You can track who made changes and when for compliance and analysis purposes.
Update Scenarios
Common Update Use Cases
Common Update Use Cases
Campaign Extension
- Extend successful campaigns beyond original end date
- Adjust start dates for delayed campaign launches
- Modify timing based on performance data
- Activate scheduled campaigns early
- Pause active campaigns temporarily
- Reactivate previously inactive campaigns
- Update campaign descriptions for clarity
- Modify campaign names for better recognition
- Adjust campaign identifiers for tracking
- Modify campaigns based on analytics data
- Adjust targeting based on customer response
- Update promotional parameters for better results
Error Responses
Common Error Scenarios
Common Error Scenarios
Campaign Not FoundInvalid Date RangeCampaign Not ModifiableValidation Error
Active Campaign Updates: Modifying active campaigns affects real-time promotions and customer experience. Consider the impact on current customers and orders in progress.
Field Validation
Update Validation Rules
Update Validation Rules
name
- Maximum length: 200 characters
- Must be unique within the company
- Cannot be empty if provided
- Maximum length: 1000 characters
- Supports basic formatting
- Optional field
- Must be unique across all campaigns
- Alphanumeric and underscore characters only
- Used for API and system integration
- Must be valid ISO 8601 timestamp
- End time must be after start time
- Past dates allowed for historical campaigns
- Must be valid status value
- Status transitions must follow business rules
- Some status changes may require additional permissions