Create Promotion

Creates a new promotion in Fourthwall.

POST

Query

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Body

Arguments

stringrequired

Promotion type. Supported values: SHOP_SINGLE, SHOP_MULTI, MEMBERSHIPS_SINGLE, MEMBERSHIPS_MULTI.

string

Promotion code for single-code variants.

array of string

Array of promotion codes for multi-code variants.

objectrequired

Discount object. For shop promotions use either a fixed amount discount or percentage discount. For membership promotions use percentage discount.

object

Requirements object. For memberships, set newMembersOnly. For shop promotions, minimumOrderValue may be provided.

string

Membership subscription type selector for membership promotion variants.

object

Membership tiers selector object for membership promotion variants.

object

Selected products object for shop promotion variants. productIds is required if this object is provided.

object

Promotion limits object for shop promotion variants. oneUsePerCustomer is required if this object is provided.

curl --request POST \ --url "https://connect.mindcloud.co/v1/universal/fourthwall/0.0.10/actions/create-promotion" \ --header "Authorization: Bearer $MINDCLOUD_API_TOKEN" \ --header "Content-Type: application/json" \ --data '{ "connectionId": "$CONNECTION_ID", "type": "", "discount": "" }'

{ "success": true, "data": [ { "appliesTo": { "type": "string" }, "code": "string", "discount": { "percentage": 1, "shippingOption": "string", "type": "string" }, "id": "string", "limits": { "maximumUsesNumber": 1, "oneUsePerCustomer": true }, "requirements": { "minimumOrderValue": 1 }, "status": "string", "type": "string", "usageCount": 1 } ], "meta": {} }

Query

Body

Every app you connect,one REST pattern