Skip to main content
POST
ads.tracking-tag.remove

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string
required

Connected account from social.accounts.list.

Required string length: 1 - 256
storeAccountId
string
required

Connected store or site to install on.

Required string length: 1 - 256
tagId
string
required

Platform-native tracking tag ID.

Required string length: 1 - 256
adAccountId
string

Platform ad account containing the tag.

Required string length: 1 - 256

Response

The result

installed
boolean
required

Whether this tag is installed.

platform
string
required

Store platform.

siteUrl
any | null

Site address; null when the site has never been published.

publishRequired
boolean

Whether a site publish is needed for the change to go live.

removed
integer

Number of installations removed.

Required range: 0 <= x <= 9007199254740991
homepageCheck
enum<string>

Homepage verification outcome.

Available options:
found,
not_found,
unreachable,
skipped