Skip to main content
PATCH
Update a promotion

Authorizations

Authorization
string
header
required

Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token.

Headers

Idempotency-Key
string

Retry-safe key; a repeat of the same request replays the first response

Maximum string length: 255

Path Parameters

id
integer
required

1club promotion id

Body

application/json

Send only what changes. validFor, segmentFilter and conditions each replace the whole object when sent.

name
string

What members see beside the discounted price

Minimum string length: 1
description
string | null
code
string | null

The promo code a member types; unique in the organization

Required string length: 2 - 40
Pattern: ^[A-Za-z0-9_-]+$
type
enum<string>
Available options:
discount,
voucher
discountFormat
enum<string> | null

Required on a discount; a voucher has none

Available options:
percent,
amount,
null
value
number

The percentage off (at most 100), or the amount in the organization's currency

Required range: x >= 0.01
startsAt
string<date-time> | null
endsAt
string<date-time> | null
maxRedemptions
integer | null

The most it may be redeemed in all; null for no limit

Required range: x >= 1
maxRedemptionsPerContact
integer | null

The most one member may redeem it; null for no limit

Required range: x >= 1
visibility
enum<string>

Who sees it offered. Defaults to Public

Available options:
Public,
Member_only,
Private
validFor
object

What it applies to. Bookings qualify through scopes, narrowed by the type ids and clubIds (empty = every one). A plan purchase qualifies only when named in planIds, or with allPlans.

segmentFilter
object

Who it is for: a buyer must match every list sent. {} is everyone.

conditions
object

When a booking qualifies. Each condition judges the whole booking.

autoApply
boolean

Applies itself at checkout without a code. Only a discount, and only with a booking scope or named planIds

Response

The updated promotion

promotionId
integer
name
string

What members see beside the discounted price

description
string | null
type
enum<string>

discount comes off what is bought; voucher is an amount the member keeps as credit

Available options:
discount,
voucher
discountFormat
enum<string> | null

A discount's form; null on a voucher, whose value is an amount

Available options:
percent,
amount,
null
value
number

The percentage off, or the amount in the organization's currency

code
string | null

The promo code a member types; null when there is none

autoApply
boolean

Applies itself at checkout, without a code

startsAt
string<date-time> | null
endsAt
string<date-time> | null
status
enum<string>

Where the promotion is in its date range now

Available options:
scheduled,
live,
ended
redemptionCount
integer

How many times it has been redeemed

maxRedemptions
integer | null

The most it may be redeemed in all; null for no limit

maxRedemptionsPerContact
integer | null

The most one member may redeem it; null for no limit

visibility
enum<string>

Who sees it offered. Defaults to Public

Available options:
Public,
Member_only,
Private
validFor
object

What it applies to. Bookings qualify through scopes, narrowed by the type ids and clubIds (empty = every one). A plan purchase qualifies only when named in planIds, or with allPlans.

segmentFilter
object

Who it is for: a buyer must match every list sent. {} is everyone.

conditions
object

When a booking qualifies. Each condition judges the whole booking.

createdAt
string<date-time>
updatedAt
string<date-time>