Reading the response

{ "is_limit_in_description": true, "char_limit_in_description": 200, "active_display_author": true, "display_author_type": "website_name" }

The top-level fields are saved local values. Read effective to see the values actually used in the output.

No include query parameter is needed. Effective values describe resolved configuration, not completed publication.

Local values or workspace defaults?

Each section has an overrides switch:

• true — use the saved local values.
• false — use the workspace defaults.

post_limit

Post count.

image_tag

Image tags and fallback image.

title_tag

Title length.

Value limits

• Post counts must be positive integers within your plan limit.
• Title length: char_limit_in_title accepts 0–1000 characters.
• Fallback image: placeholder_for_image accepts an HTTP(S) URL up to 2048 characters.
• Custom author: up to 255 characters. Send custom_author: null to reset it.

Changing settings

Send only the fields you want to change. Other fields keep their current values.

{ "post_limit": 50 }

This sets the output to at most 50 posts, within your plan limit. It does not change API list pagination.

Local values or workspace defaults?

Each section has an overrides switch:

• true — use the saved local values.
• false — use the workspace defaults.

post_limit

Post count.

image_tag

Image tags and fallback image.

title_tag

Title length.

Editing a field turns on its whole local section. When a section was inherited, its other fields start with the current workspace defaults.

To use the workspace image settings again, send:

{ "overrides": { "image_tag": false } }

Do not send image fields in that same request. Setting the switch to true alone restores the currently saved local section, not an older dashboard version.

Value limits

• Post counts must be positive integers within your plan limit.
• Title length: char_limit_in_title accepts 0–1000 characters.
• Fallback image: placeholder_for_image accepts an HTTP(S) URL up to 2048 characters.
• Custom author: up to 255 characters. Send custom_author: null to reset it.

false disables a flag. null clears the title limit or fallback URL only when that feature is disabled; it does not turn on inheritance.

Reading the response

Top-level fields show the saved local filter. effective shows the filter after workspace defaults are applied. limits reports local and inherited keyword counts.

Combining local and global filters

When a local filter has default_filter: true:

• Global and local keyword lists are combined. Their enabled matching fields apply to every word in the combined list. The whitelist is checked as one combined list.
• An enabled global flag stays enabled even if its local value is false.
• The more aggressive enabled similar-title setting takes priority.

For example, global blacklist ["ads"] plus local blacklist ["sponsored"] blocks both keywords. Clearing the local list still leaves “ads” blocked.

To use only the local filter, its default_filter must be false.

Filtering order

• no_images hides posts without an original image, even when a fallback image is configured.
• Blacklist checks run before text replacements and title truncation.

Keyword limits

Your plan limits each keyword list. Inherited keywords count toward the local total.

If a global change or plan downgrade puts an existing list over the limit, its keywords remain active. You can shrink it, but cannot grow it further. Check limits.exceeds_current_limit for this state.

Changing a keyword list

A supplied list replaces the saved list. Send [] to clear it. Spaces around keywords are removed.

{
  "blacklist": ["sponsored"],
  "blacklist_by_title": true
}

This hides posts whose title matches “sponsored”. Other filter fields stay unchanged.

Combining local and global filters

When a local filter has default_filter: true:

• Global and local keyword lists are combined. Their enabled matching fields apply to every word in the combined list. The whitelist is checked as one combined list.
• An enabled global flag stays enabled even if its local value is false.
• The more aggressive enabled similar-title setting takes priority.

For example, global blacklist ["ads"] plus local blacklist ["sponsored"] blocks both keywords. Clearing the local list still leaves “ads” blocked.

To use only the local filter, send default_filter:

{ "default_filter": false }

Filtering order

• no_images hides posts without an original image, even when a fallback image is configured.
• Blacklist checks run before text replacements and title truncation.

Keyword limits

Your plan limits each keyword list. Inherited keywords count toward the local total.

If a global change or plan downgrade puts an existing list over the limit, its keywords remain active. You can shrink it, but cannot grow it further. Check limits.exceeds_current_limit for this state.

Reading the list

The data array contains the rules in execution order. Use each rule’s id to update or delete it. Rules run in creation order. Each filter allows up to 21 rules and only one text_case rule.

Available rule types

Text

replace, remove, add_prefix, add_suffix, text_case

Links

replace_url, remove_url, remove_all_urls, replace_url_by_condition

Images

replace_image_by_condition

Visibility

hide_post

Rule order and limits

Rules run in creation order. Each filter allows up to 21 rules and only one text_case rule.

Example: replace text in a title

{
  "type": "replace",
  "take": "Old brand",
  "put": "New brand",
  "search_title": true
}

take is the text to find; put is its replacement. Each accepts up to 255 characters.

Available rule types

Text

replace, remove, add_prefix, add_suffix, text_case

Links

replace_url, remove_url, remove_all_urls, replace_url_by_condition

Images

replace_image_by_condition

Visibility

hide_post

Retrying creation safely

Send an Idempotency-Key header when creating a rule. Repeating the same key and body returns the existing rule. A conflicting body returns 409.

Keys contain 1–128 letters, digits, dots, underscores, colons or dashes. Protection lasts while the rule exists.

Rule order and limits

Rules run in creation order. Each filter allows up to 21 rules and only one text_case rule.

Send only the fields to change. Updating a rule keeps its position in the execution order.

Example: replace text in a title

{
  "type": "replace",
  "take": "Old brand",
  "put": "New brand",
  "search_title": true
}

take is the text to find; put is its replacement. Each accepts up to 255 characters.

Available rule types

Text

replace, remove, add_prefix, add_suffix, text_case

Links

replace_url, remove_url, remove_all_urls, replace_url_by_condition

Images

replace_image_by_condition

Visibility

hide_post

After deletion

The rule stops applying. A repeated delete returns 404 RULE_NOT_FOUND. Deleting a rule also releases its creation idempotency key.

Reading the switch

inherit_in_bundles: true means every bundle containing this feed receives its filtered output.

Editing a filter while inheritance is enabled

Local filter and rule changes return 409 FILTER_LOCKED. The current API requires disabling inheritance before editing and enabling it again afterward. Disabling temporarily changes the source used by every containing bundle; a failed sequence can leave it off. Global filter changes can still affect a locked feed.

Other inheritance switches

This switch is independent of default_filter, which combines workspace and local filters. A bundle’s is_bundle_inherit_feed_filter_rules option separately applies supported member-feed rules, including hide-post rules, when enabled for the workspace. It is not needed to use the feed’s processed output. Exactly-once rule execution is not guaranteed when both mechanisms are combined.

Enable or disable inheritance

inherit_in_bundles: true means every bundle containing this feed receives its filtered output.

{ "inherit_in_bundles": true }

Send false to disable it. Your plan must support filter inheritance.

Editing a filter while inheritance is enabled

Local filter and rule changes return 409 FILTER_LOCKED. The current API requires disabling inheritance before editing and enabling it again afterward. Disabling temporarily changes the source used by every containing bundle; a failed sequence can leave it off. Global filter changes can still affect a locked feed.

Other inheritance switches

This switch is independent of default_filter, which combines workspace and local filters. A bundle’s is_bundle_inherit_feed_filter_rules option separately applies supported member-feed rules, including hide-post rules, when enabled for the workspace. It is not needed to use the feed’s processed output. Exactly-once rule execution is not guaranteed when both mechanisms are combined.

Reading the response

{ "is_limit_in_description": true, "char_limit_in_description": 200, "active_display_author": true, "display_author_type": "website_name" }

The top-level fields are saved local values. Read effective to see the values actually used in the output.

No include query parameter is needed. Effective values describe resolved configuration, not completed publication.

Local values or workspace defaults?

Each section has an overrides switch:

• true — use the saved local values.
• false — use the workspace defaults.

post_limit

Post count — controls bundle_post_limit.

image_tag

Image tags and fallback image.

title_tag

Title length.

Value limits

• Post counts must be positive integers within your plan limit.
• Title length: char_limit_in_title accepts 0–1000 characters.
• Fallback image: placeholder_for_image accepts an HTTP(S) URL up to 2048 characters.

Changing settings

Send only the fields you want to change. Other fields keep their current values.

{ "bundle_post_limit": 50 }

This sets the output to at most 50 posts, within your plan limit. It does not change API list pagination.

Local values or workspace defaults?

Each section has an overrides switch:

• true — use the saved local values.
• false — use the workspace defaults.

post_limit

Post count — controls bundle_post_limit.

image_tag

Image tags and fallback image.

title_tag

Title length.

Editing a field turns on its whole local section. When a section was inherited, its other fields start with the current workspace defaults.

To use the workspace image settings again, send:

{ "overrides": { "image_tag": false } }

Do not send image fields in that same request. Setting the switch to true alone restores the currently saved local section, not an older dashboard version.

Value limits

• Post counts must be positive integers within your plan limit.
• Title length: char_limit_in_title accepts 0–1000 characters.
• Fallback image: placeholder_for_image accepts an HTTP(S) URL up to 2048 characters.

false disables a flag. null clears the title limit or fallback URL only when that feature is disabled; it does not turn on inheritance.