Campaigns Packages Partial Update

Authorization

oauth2 campaigns:write

AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: campaigns:write

Path Parameters

id*integer

Campaign ID.

packageId*integer

Package ID.

Header Parameters

X-29next-API-Version*"2024-04-01"

Default"2024-04-01"

Value in

"2024-04-01"

Request Body

interval?||

Recurring subscription interval type.

day - Day
month - Month

interval_count?Subscription Interval Count

Recurring subscription interval count.

Range0 <= value <= 2147483647

name?Package name

Package name.

Lengthlength <= 200

prices?array<>

Per-currency prices to update for the package. Currencies not included are left unchanged.

product_id?integer

ID of the product linked to the package.

product_variant_id?integer

ID of the product variant linked to the package.

recalculate_prices?boolean

Whether to recalculate prices for currencies not included in prices, via forex conversion. Source is the campaign's default currency if included in prices, else the first currency listed — include the default currency or submit only one to avoid ambiguity.

Defaultfalse

Response Body

`application/json`

curl -X PATCH "https://example.com/campaigns/0/packages/0/" \  -H "X-29next-API-Version: 2024-04-01" \  -H "Content-Type: application/json" \  -d '{}'

{  "created_at": "2019-08-24T14:15:22Z",  "id": 0,  "image": "http://example.com",  "interval": "day",  "interval_count": 0,  "is_recurring": true,  "name": "string",  "prices": [    {      "currency": "str",      "price": "string",      "price_recurring": "string"    }  ],  "product_id": 0,  "product_inventory_availability": "in_stock",  "product_name": "string",  "product_purchase_availability": "available",  "product_sku": "string",  "product_variant_attribute_values": null,  "product_variant_id": 0,  "product_variant_name": "string",  "updated_at": "2019-08-24T14:15:22Z"}