Campaigns
Create, retrieve, update, delete, and list marketing campaigns.
A campaign is a time-boxed marketing initiative that groups related coupons or offers under a single trackable entity. Use campaigns to coordinate promotions with defined start and end dates and monitor aggregate redemption activity.
Illustrative content. Hand-authored to demonstrate the Standard/Advanced pattern; the production page will be generated from the VINR OpenAPI spec (roadmap item #1). Field names are representative.
The campaign objectAsk
idstringUnique identifier for the campaign, e.g. cmp_6Eg4rS.
namestringHuman-readable name for the campaign, e.g. Summer Sale 2026.
typeenumOne of coupon or offer, indicating the kind of promotion this campaign groups.
starts_atintegerUnix timestamp when the campaign becomes active.
ends_atintegerUnix timestamp when the campaign ends. After this point redemptions are rejected.
activebooleantrue if the campaign is currently running (between starts_at and ends_at and not manually
deactivated).
redemption_countintegerTotal number of redemptions recorded against coupons or offers in this campaign.
createdintegerUnix timestamp when this campaign was created.
Create a campaignAsk
Define the campaign name, type, and schedule. Coupons or offers are associated with a campaign at creation time on the coupon/offer object.
Retrieve a campaignAsk
Fetch a campaign by its ID.
Update a campaignAsk
Update the campaign name, end date, or active status. You cannot change type after creation.
| Parameter | Type | Description |
|---|---|---|
name | string | New display name for the campaign. |
ends_at | integer | New Unix timestamp for the campaign end date. |
active | boolean | Set to false to manually deactivate a campaign before its end date. |
Delete a campaignAsk
Permanently deletes a campaign. Existing redemptions are preserved but no new redemptions can be recorded against this campaign.
List campaignsAsk
Returns a paginated list of campaigns. Filter by active to show only currently running campaigns.
| Parameter | Type | Description |
|---|---|---|
active | boolean | Return only active (true) or inactive (false) campaigns. |
limit | integer | Number of results to return. Default 10, max 100. |
Related eventsAsk
campaign.created, campaign.updated, and campaign.ended. See Events.
