Skip to main content
PUT
cURL
Turns the merchant’s placement for one offer type on your platform off or on. Call it when the merchant turns your Branduo placement off or removes your app (false), and when it’s back (true).
  • Off pauses all of the merchant’s campaigns of that type on your platform. Nothing is deleted, and their results are kept.
  • On resumes them. For an offer type you started serving after the merchant approved, true also starts their campaign of that type.
  • It never creates an approval, and it never touches a merchant who hasn’t approved you.
If your placement is always on, you never need to call it. Every change is logged with your platform, the time, and the value before and after. The merchant must have approved your platform.
cURL

Path parameters

string
required
The merchant’s store domain, *.myshopify.com or custom.
string
required
The offer type key, for example post-purchase. It must be a type your platform serves.

Request body

boolean
required
true to turn the placement on, false to turn it off.

Response

string
required
The store’s *.myshopify.com domain.
string
required
The offer type key.
boolean
required
The placement after this call.
boolean
required
Whether the merchant’s campaign of this type is live on your platform now. Turning placement on doesn’t make it live if something else holds it back (for example, usage billing is off). Get a brand says why in pausedReason.

Errors