commerce
commerce

Edit Offer

Extend, shorten, re-cap, bind or annotate a code. Null clears; absent keeps.

patch/api/v1/commerce/offers/{code}

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/commerce/offers/{code}
  • Auth: API key in header X-API-Key

Path parameters

codestring required

Request body

cap_recordsinteger nullable
cap_centsinteger nullable
bound_emailstring nullable
expires_atstring date-time nullable
expires_in_daysinteger nullable
notestring nullable

Response

Successful Response

codestring required
unit_centsinteger required
statusstring required
rulestring required
cap_recordsinteger nullable required
cap_centsinteger nullable required
remaining_recordsinteger nullable required
remaining_centsinteger nullable required
redeemed_recordsinteger required
redeemed_centsinteger required
bound_emailstring nullable required
expires_atstring date-time nullable required
revoked_atstring date-time nullable required
notestring nullable required
created_atstring date-time nullable required
ordersinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.