Policy

Rename, pause, reconfigure or rescope a policy rule

Changes a policy rule. Omitted fields keep their current value; type and params go together (send both to change the configuration); scope replaces the whole scope. Existing cases and findings are kept. Types and params: forbidden_terms {terms, fields: headline|description|display_url, applies_to, authorized_domains}; brand_term {extra_terms, authorized_domains}; direct_linking {authorized_domains}; promo_code {codes, any_explicit_code, allowed_codes, applies_to, authorized_domains}; position_limit {top_positions 1-10, applies_to, authorized_domains}; affiliate_id {authorized_ids}. applies_to is unauthorized (default for position limits) or all_non_owned (default for terms and codes). Your own domains never match, except for affiliate_id; advertisers classified as authorized retailers and authorized_domains count as authorized. Requires the write scope.

post/projects/{project_id}/policy-rules/{rule_id}

Request

  • Base URL: https://adslighthouse.com/api/v1
  • URL: https://adslighthouse.com/api/v1/projects/{project_id}/policy-rules/{rule_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project: its id, its brand domain (for example nike.example) or its exact project or brand name. Unknown or ambiguous references return not_found; call list_projects then.

rule_idstring required

The policy rule id from list_policy_rules.

Request body

namestring

A name your team recognizes, up to 120 characters.

enabledboolean

false saves the rule paused. Defaults to true.

type'forbidden_terms' | 'brand_term' | 'direct_linking' | 'promo_code' | 'position_limit' | 'affiliate_id'

Response

Rename, pause, reconfigure or rescope a policy rule

idstring required
project_idstring required
namestring required
type'forbidden_terms' | 'brand_term' | 'direct_linking' | 'promo_code' | 'position_limit' | 'affiliate_id' required
enabledboolean required
readableboolean required

False when the stored configuration no longer parses; such a rule is skipped.

open_casesinteger required
created_atstring required
updated_atstring required
request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.