Campaigns 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.

Header Parameters

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

Default"2024-04-01"

Value in

"2024-04-01"

Request Body

additional_currencies?array<>

Currencies supported in addition to the default currency.

available_express_payment_methods?array<string>

Express payment method codes to enable, drawn from the resolved payment gateway group.

available_payment_methods?array<string>

Payment method codes to enable, drawn from the resolved payment gateway group.

available_shipping_countries?array<string>

ISO 3166-1 alpha-2 country codes the campaign can ship to.

language?string

Preferred language for customers of this campaign.

Lengthlength <= 3

name?string

Campaign name used internally for reference.

Lengthlength <= 200

payment_gateway_group_id?integer

Payment gateway group used instead of the store default.

Range0 <= value <= 2147483647

paypal_account_id?integer

PayPal account used instead of the store default.

statement_descriptor?string

Descriptor shown on the customer's card statement.

Lengthlength <= 255

Response Body

`application/json`

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

{  "additional_currencies": [    "str"  ],  "api_key": "string",  "available_express_payment_methods": [    {      "code": "string",      "name": "string"    }  ],  "available_payment_methods": [    {      "code": "string",      "name": "string"    }  ],  "available_shipping_countries": [    {      "code": "string",      "name": "string"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "currency": "str",  "id": 0,  "language": "str",  "name": "string",  "payment_gateway_group_id": 0,  "payment_gateway_group_name": "string",  "paypal_account_id": 0,  "statement_descriptor": "string",  "updated_at": "2019-08-24T14:15:22Z"}