Edit a promotion
Edit a promotion by replacing it, exactly like editing from the dashboard: the referenced promotion is stopped, a new promotion is created with the provided values, and eligible fans are notified of the updated offer.
The response contains the replacement promotion, whose uuid differs from the one in the path and whose usedCount starts at zero. Fans who redeemed the original promotion keep their discounted price or trial. If the new values target a different audience group, any existing promotion for that audience is also replaced.
write:creator— Modify creator profiles, settings, and creator-specific data.
Authorizations
OAuth 2.0 access token, presented as a JWT bearer token in the Authorization header. Obtain a token via the authorization-code flow; the scopes granted to the token determine which operations it may call.
Headers
API version to use for the request
"2025-06-26"
Path Parameters
Promotion UUID
Body
Which fans can redeem the promotion: new_subscribers (never subscribed), expired_subscribers, followers, or all
new_subscribers, expired_subscribers, all, followers First-month discount as a percentage of the subscription price. Mutually exclusive with a free trial.
1 <= x <= 100Set to true to offer a free trial. Combine with freeTrialDays for a fixed length, or omit freeTrialDays for an unlimited (free-forever) trial. Mutually exclusive with discountPercent. Passing freeTrialDays alone also implies a free trial.
Length of the free trial in days (1-30). Omit while freeTrial is true for an unlimited (free-forever) trial. Mutually exclusive with discountPercent.
1 <= x <= 30Maximum number of redemptions. Unlimited when omitted.
1 <= x <= 1000When the promotion stops being redeemable. Never expires when omitted.
Optional message shown to fans with the promotion
Response
Promotion updated successfully
Promotion UUID
Whether the promotion is a first-month discount or a free trial
discount, free_trial Discount percentage (null for free-trial promotions)
Free trial length in days (null for discount promotions)
Which fans can redeem the promotion: new_subscribers (never subscribed), expired_subscribers, followers, or all
new_subscribers, expired_subscribers, all, followers When the promotion expires (null if it never expires)
Maximum number of redemptions (null if unlimited)
Number of times the promotion has been redeemed
Message shown to fans with the promotion
When the promotion was created