addresses5

adjustments5

adyen_gateways5

adyen_payments5

application1

attachments5

authorizations3

avalara_accounts5

axerve_gateways5

axerve_payments5

billing_info_validation_rules5

bing_geocoders5

braintree_gateways5

braintree_payments5

bundles5

buy_x_pay_y_promotions5

captures3

carrier_accounts5

checkout_com_gateways5

checkout_com_payments5

cleanups5

coupon_codes_promotion_rules5

coupon_recipients5

coupons5

custom_promotion_rules5

customer_addresses5

customer_groups5

customer_password_resets5

customer_payment_sources5

customer_subscriptions5

customers5

delivery_lead_times5

discount_engine_items2

discount_engines2

easypost_pickups5

event_callbacks2

event_stores1

events3

exports5

external_gateways5

external_payments5

external_promotions5

external_tax_calculators5

fixed_amount_promotions5

fixed_price_promotions5

flex_promotions5

free_gift_promotions5

free_shipping_promotions5

geocoders2

gift_card_recipients5

gift_cards5

google_geocoders5

has_many440

has_one236

imports5

in_stock_subscriptions5

inventory_models5

inventory_return_locations5

inventory_stock_locations5

klarna_gateways5

klarna_payments5

line_item_options5

line_items5

links5

manual_gateways5

manual_tax_calculators5

markets5

merchants5

notifications5

order_amount_promotion_rules5

order_copies5

order_factories2

order_subscription_items5

order_subscriptions5

order_validation_rules2

orders5

organization1

packages5

parcel_line_items5

parcels5

payment_gateways2

payment_methods5

payment_options5

paypal_gateways5

paypal_payments5

percentage_discount_promotions5

pickups2

price_frequency_tiers5

price_list_schedulers5

price_lists5

price_tiers2

price_volume_tiers5

prices5

promotion_rules2

promotions2

recurring_order_copies5

refunds3

reserved_stocks2

resource_errors2

return_line_items5

returns5

satispay_gateways5

satispay_payments5

shipment_line_items2

shipments5

shipping_categories5

shipping_method_tiers2

shipping_methods5

shipping_weight_tiers5

shipping_zones5

sku_list_items5

sku_list_promotion_rules5

sku_lists5

sku_options5

skus5

stock_items5

stock_line_items5

stock_locations5

stock_reservations5

stock_transfers5

stores5

stripe_gateways5

stripe_payments5

stripe_tax_accounts5

subscription_models5

tags5

talon_one_accounts5

tax_calculators2

tax_categories5

tax_rules5

taxjar_accounts5

transactions2

vertex_accounts5

voids3

webhooks5

wire_transfers5

free_gift_promotions

Update a free gift promotion

Changed on Jul 13, 2026

patch/free_gift_promotions/{freeGiftPromotionId}

Request

Base URL
https://{your_organization_slug}.commercelayer.io/api
URL
https://{your_organization_slug}.commercelayer.io/api/free_gift_promotions/{freeGiftPromotionId}
Auth
HTTP bearer

Path parameters

freeGiftPromotionIdstring required

The resource's id

Request body

Example request

{
  "data": {
    "id": "XAyRWNUzyN",
    "attributes": {
      "name": "Personal promotion",
      "currency_code": "EUR",
      "exclusive": true,
      "priority": 2,
      "starts_at": "2018-01-01T12:00:00.000Z",
      "expires_at": "2018-01-02T12:00:00.000Z",
      "total_usage_limit": 5,
      "_disable": true,
      "_enable": true,
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      },
      "max_quantity": 3
    },
    "relationships": {
      "market": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "order_amount_promotion_rule": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "sku_list_promotion_rule": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "coupon_codes_promotion_rule": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "custom_promotion_rule": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "sku_list": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      },
      "tags": {
        "data": {
          "id": "XAyRWNUzyN"
        }
      }
    }
  }
}

Response

The updated free gift promotion object

Changes

Jul 13, 2026859097ed3fe6 Revision changes
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  added the new required request property ///
- breaking
  request property / was restricted to a list of enum values
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property //
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- warning
  removed the request property ///
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  added the new optional request property //
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property // became nullable
- info
  the request property default value free_gift_promotions was removed
- info
  added the new free_gift_promotions enum value to the request property /
- info
  added the media type application/vnd.api+json for the response with the status

Operation history

Update a free gift promotion

Request

Path parameters

Request body

Example request

Response 200OK

Changes

Response