Click Here to Register for the Next Webinar - October 28th @ 2 pm Eastern
    InboundInsight
    APIsUpdate Pixel Settings

    Update Pixel Settings

    POSThttps://apikey.inboundinsight.app/api/pixel-settings

    Update the configuration of an existing Visitor Connect pixel, including geographic targeting, engagement rules, bundle config, delivery settings, and advanced output options.

    📘

    The client_key field identifies the pixel to update. All other fields are optional — only include the settings you want to change.

    Headers

    HeaderValue
    AuthorizationAPI_KEY

    Body Parameters

    client_keystringrequired

    The client_key is available in the Customer Settings area within the dashboard.

    delete_pixelboolean

    Set to true to delete the pixel. When provided, only client_key is needed.

    client_namestring

    Updated client name (letters and numbers only)

    company_domainsstring[]

    Updated array of domains (e.g. example.com)

    filename_prefixstring

    Updated filename prefix (letters and numbers only, no special characters or spaces)

    pixel_statusstring

    Pixel status:

    • Off

    • Live

    • Test

    • Lapsed

    • Paused

    output_typestring

    Output format:

    • B2C Fields Only

    • B2C Fields and B2B Where Available

    • B2B Records Only

    prior_suppressionstring

    Prior suppression setting:

    • 1 Month Only

    • 2 Months Only

    • 3 Months Only

    • 4 Months Only

    • 5 Months Only

    • 6 Months Only

    • 1 Year

    • 2 Years

    • 3 Years

    • Always

    media_prioritystring

    Media priority:

    • Email

    • Name + Address

    • Email + Name + Address

    • Any

    file_frequencystring

    Updated delivery frequency: Daily or Weekly

    max_monthly_leads_qtyinteger | null

    Updated monthly lead quantity cap (integer, min 0). Nullable.

    max_daily_lead_qtyinteger | null

    Updated daily lead quantity cap (integer, min 0). Cannot exceed max_monthly_leads_qty. Nullable.

    pixel_start_datestring | null

    Updated start date (YYYY-MM-DD HH:mm:ss). Must be in the future (EST). Nullable.

    pixel_stop_datestring | null

    Updated stop date (YYYY-MM-DD HH:mm:ss). Must be after pixel_start_date. Nullable.

    geo_inclusionobject

    mode (enum): Geographic targeting mode.

    • entire_usa

    • states

    • zip_codes

    states (array of strings): List of 2-letter state codes (required when mode is states).

    zip_codes (array of strings): List of 5-digit zip codes (required when mode is zip_codes).

    bundle_configobject

    activate_bundle (boolean): Indicates whether the bundle should be enabled or disabled.

    phone_append_packages (enum): Select one of the following:

    • No Phone Append

    • Phone Append - Mobile

    • Phone Append - Individual

    • Phone Append - Household

    demo_append_packages (array of strings): Available options:

    • Core Demos (53)

    • Top Demos (9)

    • Wealth/Credit (3)

    • Month of Birth (1)

    • Personicx (10)

    • Connex (15)

    pixel_rulesobject

    fire_on (object): Page firing configuration.

    • mode (enum): include, exclude, or all

    • pages (array of strings): List of page paths

    prevent_fire_pages (array of strings): Full URLs or paths starting with / to exclude.

    engagement_rules (object): Visitor engagement requirements.

    • page_views (integer): Required page views (1–5)

    • time_on_site (integer): Required time on site in seconds (min 1)

    • logic (enum): AND or OR

    sftp_deliveryobject

    enabled (boolean): Enable or disable SFTP delivery.

    account_type (enum): SFTP account type.

    • platform_provided

    • client_provided

    host (string): SFTP host (FQDN). Required when enabled.

    username (string): SFTP username. Required when enabled.

    password (string): SFTP password. Required when enabled.

    port (integer): SFTP port (1–65535, default 22).

    folder (string): Target folder absolute path. Required when enabled.

    advanced_output_optionsobject

    active_control_allocation (object): Active/control split.

    • active_percent (integer): Active percentage (0–100)

    • control_percent (integer): Control percentage (0–100)

    • Must sum to 100

    behavioral_data (array of objects): Behavioral data triggers.

    • url (string): Full URL or absolute path

    • value (string): Associated behavior value

    use_gtm (boolean): Enable Google Tag Manager output integration.

    Changelog