OfferVersion: v3New

Update Offer

PUT/courses/offers/{offerId}

Update a membership offer. Requires a Location token with courses.write. Send Version: v3. Returns the full offer. locationId, id, userId, originId, and addProductToMembers are not accepted.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:courses.write

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Path Parameters

offerIdstring<uuid>required

Offer id

Possible values: non-empty

Example:c3d4e5f6-7890-4123-cdef-123456789012

Query Parameters

locationIdstringrequired

Location id or sub-account id is required.

Possible values: non-empty

Example:ve9EPM428h8vShlRW1KT

Body

application/json

descriptionstringnullable

typestring

Available optionsfreeonetimesubscription

amountnumber

currencystring

Example:USD

priceDisplayOverridestringnullable

isLivePaymentModeboolean

intervalstring

Available optionsweekmonthyearday

intervalCountnumber

trialDaysnumber

setupFeenumber

numberOfPaymentsnumber

visibilitystring

Available optionspublisheddraft

accessDatestringnullable

daysOfAccessnumbernullable

customJsstringnullable

customCssstringnullable

customHeaderstringnullable

customFooterstringnullable

couponsstring[]

posterImagestringnullable

titlestring

Example:Founding members

productIdsstring[]

Product ids included in this offer

Response

application/json

Success

idstringrequired

Example:c3d4e5f6-7890-4123-cdef-123456789012

titlestringrequired

Example:Founding members

descriptionstringnullablerequired

typestringrequired

Available optionsfreeonetimesubscription

sourcestringrequired

Example:membership

amountnumbernullablerequired

currencystringnullablerequired

priceDisplayOverridestringnullablerequired

isLivePaymentModebooleannullablerequired

intervalstringnullablerequired

Available optionsweekmonthyearday

intervalCountnumbernullablerequired

trialDaysnumbernullablerequired

setupFeenumbernullablerequired

numberOfPaymentsnumbernullablerequired

visibilitystringrequired

Available optionspublisheddraft

accessDatestringnullablerequired

daysOfAccessnumbernullablerequired

customJsstringnullablerequired

customCssstringnullablerequired

customHeaderstringnullablerequired

customFooterstringnullablerequired

couponsobject[]nullablerequired

posterImagestringnullablerequired

paymentProductIdstringnullablerequired

Read-only Payments catalog id generated by membership

paymentPriceIdstringnullablerequired

Read-only Payments price id generated by membership

productsobject[]required

createdAtstringrequired

updatedAtstringrequired