Browse the help center

Create site API JSON field targeting

Creates an API JSON field targeting rule for the specified site.

Reference
POST https://YOUR-NETWORK-DOMAIN/rest-api/site/{siteId}/targeting/api-json-field/create.do

Creates an API JSON field targeting rule for the specified site. The rule calls an external API URL and checks a specific JSON field in the response for the expected value. This enables dynamic targeting based on external data sources. Returns the created targeting rule on success. Requires API_JSON_FIELD targeting permission.

Path Params

siteId integer required

Unique numeric ID of the site

3001

Form Params

rule string required

Targeting rule type — INCLUDE for whitelist or EXCLUDE for blacklist

INCLUDE

apiUrl string required

External API URL to call for targeting data

https://api.example.com/check

jsonField string required

JSON field name to extract from the API response

eligible

jsonFieldValue string required

Expected value of the JSON field to match against

true

Responses

200

Success

400

Invalid targeting value

401

Unauthorized

403

Forbidden

404

Site not found

500

Internal server error

Please disable Adblock
Are you using adblock? Disable it and reload the page to proceed to the destination page.

A registration has already been submitted from this page. Please try again in 10 minutes.