Meta tags:
description= When you trigger a broadcast, you can send data to personalize your message or override your audience. This page helps you understand the format of that data and how to set up complex recipient groups.;
Headings (most frequently used words):
recipients, with, custom, data, specify, segments, attributes, and, ids, email, customer, io, segment, your, format, api, triggered, broadcasts, how, can, we, make, it, better, providing, overriding, recipient, list, including, combining, profile, addresses, latest, features, at, or, not, audience, using, multiple, new, names, for, familiar, parts, of, see, which, clients, use, manage, all, accounts, single, login,
Text of the page (most frequently used words):
the (138), and (108), your (89), data (86), app (78), messages (77), push (77), for (53), you (51), email (51), set (48), profiles (46), events (45), #customer (44), started (43), notifications (39), track (39), with (38), attribute (38), api (34), get (30), metrics (29), identify (29), how (28), segment (28), send (27), use (27), troubleshooting (27), message (26), objects (25), recipients (24), that (24), custom (23), multiple (23), value (23), roadrunner (23), not (22), true (22), tracking (22), this (21), from (21), json (21), array (21), can (19), emails (19), links (19), profile (18), ids (18), start (18), account (18), operator (17), conditions (17), create (17), mobile (17), changelog (17), event (17), what (16), results (16), audience (16), anonymous (16), getting (16), page (15), segments (15), using (15), automation (15), broadcast (14), information (14), field (14), automations (14), support (13), will (13), example (13), text (13), dashboard (13), more (13), com (13), manage (13), listeners (13), deep (13), activity (13), test (13), file (12), reports (12), view (12), must (12), authentication (12), new (12), users (12), quick (12), guide (12), inbox (12), google (12), integrations (12), addresses (11), are (11), errors (11), line (11), headline (11), spotted (11), albuquerque (11), date (11), received (11), immediate (11), area (11), head (11), content (11), match (11), messaging (11), capture (11), options (11), subscription (11), list (10), per_user_data (10), returns (10), return (10), trigger (10), object (10), coyote (10), condition (10), filter (10), filters (10), add (10), update (10), inline (10), android (10), channels (10), screen (10), lifecycle (10), privacy (9), our (9), specify (9), any (9), one (9), triggered (9), edit (9), handling (9), providers (9), configuration (9), works (9), migrate (9), advanced (9), transactional (9), editor (9), need (8), attributes (8), here (8), url (8), like (8), which (8), provided (8), each (8), january (8), 2018 (8), sending (8), broadcasts (8), billing (8), notification (8), webhooks (8), liquid (8), features (7), overview (7), request (7), email_add_duplicates (7), format (7), wiley (7), settings (7), all (7), security (7), flutter (7), packages (7), version (7), design (7), studio (7), integration (7), introduction (7), forms (7), time (7), components (7), service (6), has (6), block (6), same (6), couldn (6), parse (6), when (6), might (6), have (6), workspace (6), code (6), global (6), case (6), then (6), syntax (6), exists (6), complex (6), groups (6), sms (6), ios (6), react (6), native (6), amazon (6), inbound (6), about (5), pipelines (5), while (5), processing (5), receive (5), email_ignore_missing (5), values (5), see (5), https (5), data_file_url (5), server (5), want (5), but (5), error (5), caller (5), some (5), criteria (5), based (5), single (5), understand (5), best (5), practices (5), whatsapp (5), updates (5), location (5), earlier (5), rules (5), reference (5), frequently (5), asked (5), questions (5), legacy (5), hubspot (5), actions (5), out (5), javascript (5), welcome (5), link (5), css (5), analysis (5), policy (4), status (4), journeys (4), platform (4), copy (4), may (4), fields (4), also (4), next (4), following (4), missing (4), xxxx (4), where (4), two (4), ignored (4), call (4), their (4), boolean (4), customers (4), roadrunners (4), target (4), likes_baseball (4), people (4), nest (4), other (4), preview (4), personalize (4), 2026 (4), accounts (4), builder (4), rich (4), apis (4), conversions (4), snowflake (4), reporting (4), storage (4), bigquery (4), redshift (4), webhook (4), client (4), understanding (4), tests (4), recipes (4), branches (4), timestamp (4), delete (4), opt (4), statuses (4), preferences (4), component (4), faq (4), styles (4), layouts (4), domain (4), style (4), relationships (4), docs (4), documentation (3), team (3), feedback (3), part (3), help (3), make (3), recipient (3), found (3), contain (3), correspond (3), id_ignore_missing (3), way (3), through (3), parameters (3), non (3), 1511315635 (3), road (3), runner (3), net (3), voucher_code (3), should (3), number (3), files (3), below (3), specified (3), include (3), 000 (3), sent (3), john (3), different (3), unless (3), matching (3), interest (3), override (3), separate (3), find (3), string (3), person (3), required (3), false (3), items (3), basic (3), releases (3), login (3), conversion (3), workspaces (3), sign (3), assign (3), roles (3), standard (3), performance (3), upgrade (3), expo (3), implementation (3), certificates (3), visual (3), website (3), twilio (3), slack (3), salesforce (3), mixpanel (3), facebook (3), ads (3), cohorts (3), triggers (3), map (3), reverse (3), etl (3), beta (3), live (3), common (3), compliance (3), deliverability (3), goals (3), web (3), multi (3), types (3), workflow (3), workflows (3), why (3), center (3), templates (3), surveys (3), phone (3), integrate (3), drag (3), drop (3), smtp (3), export (3), via (3), csv (3), mcp (3), agent (3), clients (3), contact (2), resources (2), pricing (2), parcel (2), soon (2), provide (2), address (2), close (2), better (2), download (2), including (2), combining (2), overriding (2), providing (2), tracked (2), don (2), allow (2), used (2), careful (2), option (2), means (2), per_user_data_error_count (2), found_per_user_data (2), per_user_data_position (2), checking (2), product (2), price (2), formatted (2), look (2), upsell_runners (2), containing (2), user (2), process (2), collapse (2), contains (2), included (2), available (2), building (2), above (2), both (2), matt (2), let (2), acme (2), existing (2), exist (2), than (2), result (2), returned (2), simple (2), these (2), either (2), state (2), does (2), equal (2), belong (2), define (2), individual (2), against (2), name (2), supports (2), represents (2), compound (2), specific (2), group (2), examples (2), composer (2), updated (2), index (2), browser (2), issues (2), store (2), cookies (2), expiration (2), search (2), access (2), members (2), plan (2), tasks (2), audit (2), logs (2), verification (2), provisional (2), sound (2), sdks (2), html (2), comparing (2), pixel (2), sendgrid (2), marketing (2), rudderstack (2), azure (2), blob (2), cloud (2), audiences (2), braze (2), amplitude (2), connections (2), past (2), mode (2), servers (2), deleting (2), services (2), postgresql (2), mysql (2), microsoft (2), sql (2), incoming (2), requests (2), csp (2), proxying (2), management (2), another (2), disconnect (2), backend (2), form (2), lead (2), video (2), semantic (2), directory (2), personalization (2), zone (2), reusable (2), exit (2), flow (2), names (2), batch (2), concepts (2), sends (2), reminders (2), upcoming (2), trial (2), book (2), nps (2), frequencies (2), aren (2), library (2), brand (2), adding (2), localization (2), activities (2), respond (2), feature (2), adoption (2), promotions (2), display (2), build (2), sender (2), validate (2), senders (2), headers (2), adapting (2), template (2), own (2), relay (2), collaborate (2), connected (2), review (2), accessibility (2), shortcuts (2), devices (2), work (2), segmentation (2), collections (2), import (2), survey (2), suggestions (2), setup (2), cli (2), academy (2), structured (2), learning (2), demo (2), 2024, peaberry, software, inc, terms, 9450, gemini, suite, 43920, beaverton, oregon, 97008, 7105, win, startup, program, partners, careers, company, guides, competitors, community, blog, release, notes, possible, appreciate, bot, please, valid, optional, improve, yes, helpful, copied, clipboard, there, automatically, been, completed, ignore, continue, flag, once, again, copies, coyottee, crocodile, encountered, provides, zero, specifying, limit, endpoint, 16100, workflow_action_ids, 3000, recipients_count, 1552523331, processed_at, recipients_filter, 1552523326, created_at, campaign_id, fast50, customer_456, gadget, customer_123, widget, newline, delimited, contents, amazonaws, awesometown, recorded, far, position, processed, bytes, whether, was, http, recommend, hosting, sensitive, requires, password, those, point, plain, progress, visible, pass, myserver, myfile, cym6xj, feswym, uglify, prevent, important, remove, linebreaks, identifier, depending, present, them, voucher, space, exactly, attribute_name, total, three, whereas, say, implication, sake, assume, corresponds, added, mailed, times, warning, application, situations, desirable, species, alternately, combination, general, addition, accept, operators, note, into, entries, would, expression, looks, numerical, hovering, over, info, icon, determine, evaluate, accepted, matches, integer, excludes, take, least, first_name, sets, meet, breaking, news, layout, few, useful, always, meets, libraries, sample, helps, july, 5_api, complete, llms, txt, har, qualifications, respecting, gdpr, allowlist, session, sensitivity, timezone, enable, experimental, regions, sso, factor, credentials, customize, canceling, payment, problems, reducing, overages, credits, bill, sdk, channel, swift, zendesk, yandex, wisepops, optimizer, vwo, twitter, engage, tiktok, talon, sprig, saleswings, ripe, qualtrics, playerzero, pipedrive, pinterest, moengage, metronome, meta, logrocket, livelike, launchdarkly, koala, intercom, heap, tag, manager, gtm, sheets, analytics, gtag, gainsight, fullstory, friendbuy, criteo, cordial, commandbar, clevertap, bing, attio, algolia, insights, adobe, actable, predictive, resend, filtering, mapping, database, warehouse, action, zoho, zapier, mparticle, classic, platforms, python, node, calculator, scheduled, syncs, invalid, transform, utility, methods, identity, managing, identities, method, frameworks, wordpress, wpforms, webflow, unbounce, typeform, squarespace, jotform, formstack, sources, backfill, historical, playback, chat, ecommerce, alias, source, specs, failed, attempted, conclusive, home, reusing, snippets, limits, supported, formats, zones, recommended, geolocation, queue, draft, behavior, default, direct, mail, lob, configure, randomized, delay, wait, until, window, delays, blocks, random, split, control, reformat, fix, inconsistent, journey, holdout, llm, generate, decisions, key, inactive, trips, rss, feed, cohort, optimize, just, words, onboarding, double, cart, abandonment, birthday, anniversary, recipe, grace, periods, tickets, syncing, sync, stripe, follow, responses, receiving, entering, troubleshoot, change, schedule, tags, image, requirements, assets, outside, language, preference, faqs, pages, unsubscribes, universal, translations, translate, languages, milestones, achievements, promote, offers, localize, step, compose, telehealth, weight, hipaa, regulations, kind, campaign, registration, compliant, register, numbers, keyword, smart, character, encoding, keywords, shortening, mms, payloads, registering, device, tokens, provider, trustpilot, reviews, gmail, fake, bcc, preheader, avatar, logo, mailchimp, column, foundation, amp, pre, archive, customizing, basics, choose, right, editors, consent, open, oracle, dyn, sparkpost, postmark, mandrill, mailjet, mailgun, verify, deliverable, kickbox, anonymized, authenticating, apple, private, unsubscribe, rfc, 8058, postmaster, tools, suppression, lists, suppressions, spamhaus, blocklist, listings, shared, dedicated, warming, attachments, creating, transitioning, history, submit, teammates, stylesheet, loop, conditionals, directives, modifiable, placeholder, scratch, publish, changes, connect, quality, mso, emmet, fixes, variables, cleanup, formatting, inlining, mjml, framework, transformers, responsive, dark, keyboard, convert, setting, purposes, within, days, manual, driven, activate, waitlist, awareness, announce, drive, usage, upsell, monetize, power, cases, tutorials, they, external, merging, know, storing, suppress, last, visited, resolve, duplicate, cursor, ides, claude, chatgpt, command, routines, skills, ask, longer, guest, tab, section, breaks, down, opens, clicks, tells, navigation, labels, think, campaigns, now, familiar, parts, latest, log,
Text of the page (random words):
new 3 x 3 13 0 3 x 3 9 0 2 x 3 x 1x 2 x changelog ios get started identify profiles track events push notifications rich push notifications in app messages test support changelog ios get started identify profiles track events push notifications in app messages test support update from 2 10 to 2 11 migrate from an earlier version troubleshooting changelog android quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify profiles screen tracking mobile lifecycle events anonymous activity track events location tracking push notifications push notifications deep links channel push service certificates test your push implementation in app messages in app messages in app event listeners inline in app messages page rules notification inbox what s new 4 x 4 10 3 x 4 x 2 x 3 x changelog android get started identify profiles track events push notifications in app messages test support migrate from an earlier version troubleshooting changelog android get started identify profiles track events push notifications rich push notifications test support migrate from an earlier version changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify profiles track events screen tracking mobile lifecycle events anonymous activity location tracking push notifications set up push notifications app groups for push tracking deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners notification inbox what s new 6 x 6 4 0 5 x 6 0 0 4 x 5 0 0 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify profiles track events screen tracking mobile lifecycle events anonymous activity push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners what s new 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track users identify profiles track events screen tracking mobile lifecycle events anonymous activity push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages set up in app messages inline in app messages in app event listeners what s new 4 x 5 0 0 4 x 4 3 3 4x 4 x 3 x 3 4 2 x 3 x changelog react native get started identify profiles track events push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting migrate from an earlier version troubleshooting changelog react native get started identify profiles track events push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting migrate from an earlier version update to version 3 4 troubleshooting changelog expo quick start guide getting started how it works authentication packages and configuration options troubleshooting identify and track profiles identify profiles track events screen tracking mobile lifecycle events anonymous activity location tracking push notifications set up push notifications app groups for push tracking deep links capture push metrics android channels multiple push providers in app messages inline in app messages notification inbox set up in app messages in app event listeners what s new 3 x 3 3 2 x 3 x 1x 2 x changelog expo get started identify profiles track events push notifications set up push notifications deep links capture push metrics in app messages set up in app messages in app event listeners updates and troubleshooting troubleshooting changelog flutter quick start guide get started how it works authentication configuration options troubleshooting identify track users identify profiles mobile lifecycle events anonymous activity screen tracking track events location tracking push notifications set up push notifications app groups for push tracking deep links handling multiple push providers capture push metrics android channels in app messages in app messages inline in app messages notification inbox in app event listeners what s new 3 x 4 0 0 3 x 3 5 0 2 x 3 0 0 2 x 2 2 upgrade to flutter 2 x changelog flutter quick start guide get started how it works authentication configuration options troubleshooting identify track users identify profiles mobile lifecycle events anonymous activity screen tracking track events push notifications set up push notifications deep links handling multiple push providers capture push metrics android channels in app messages in app messages inline in app messages in app event listeners what s new 2 x 2 2 upgrade to flutter 2 x changelog flutter get started identify profiles track events update flutter sdk push notifications set up push notifications deep links handling multiple push providers capture push metrics in app messages in app messages in app event listeners updates and troubleshooting update ios troubleshooting changelog settings billing account verification audit logs tasks workspace performance billing how we bill billing for sms messages billing for whatsapp messages ai credits reducing billing overages payment problems canceling your account plan features builder plan your account manage team members how to add team members assign standard roles create assign custom roles access multiple accounts edit account information customize your ui manage your api credentials security best practices two factor authentication single sign on sso account regions us and eu enable experimental features workspaces workspaces in customer io understand timezone conversion case sensitivity and your data search your workspace privacy security session cookies and expiration allowlist our ip addresses customer io gdpr and you security mobile and app store privacy privacy respecting your users privacy ai settings customer io security qualifications troubleshooting troubleshooting login and browser issues create a har file for help troubleshooting releases this page is part of the customer io documentation for the complete documentation index see llms txt messaging send broadcasts 5_api triggered data format md 40 format api triggered broadcasts updated july 15 2026 when you trigger a broadcast you can send data to personalize your message or override your audience this page helps you understand the format of that data and how to set up complex recipient groups providing custom data you ll send custom data using our api or our libraries you can also see sample data in our composer preview here s a basic example of what some custom data might look like in your request data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information overriding recipients you can set the audience for an api triggered broadcast in the ui which is useful when your audience always meets the same conditions but you might want to define a custom audience when you trigger your broadcast for example you might send breaking news notifications to different groups of users but the same content layout we support a complex set of audience filters so you can broadcast to a specific group of profiles we ve provided a few basic examples below you can nest and and or filters nest filters to create complex filters where you have different sets of and and or criteria that a profile must meet to receive your broadcast and and the and filter is an array of objects where each object represents criteria for your audience each object must be true for a profile to receive the broadcast you can nest other compound filters or or not to set up complex audience conditions recipients and attribute field first_name operator exists attribute field likes_baseball operator eq value true and array of objects match all conditions to return results not returns results if a condition is false while and or support an array of items not supports a single filter object and array of objects match all conditions to return results or array of objects match any condition to return results or array of objects returns results matching any conditions or or the or filter is an array of objects where each object represents criteria for your audience at least one object in the array must be true for a profile to receive the broadcast you can nest other compound filters and or not to set up complex audience conditions recipients or segment id 4 attribute field likes_baseball operator eq value true or array of objects match any condition to return results and array of objects returns results matching all conditions not returns results if a condition is false while and or support an array of items not supports a single filter object and array of objects match all conditions to return results or array of objects match any condition to return results not not a condition that if true excludes profiles from your audience the not filter is an object but can take a complex filter like and or or recipients not and segment id 3 attribute field likes_baseball operator eq value true and array of objects match all conditions to return results or array of objects match any condition to return results segment segment a id of a segment that profiles must belong to recipients segment id 3 id integer the id of the segment you want to return people from audience audience filter your audience based on an attribute value in this case you ll provide field the name of the attribute operator one of exists true if a person has a value or eq true if a person matches a value value required if you use the eq operator the value a profile s attribute must equal eq for the condition to be true recipients attribute field likes_baseball operator eq value true field string required the name of the attribute you want to filter against operator string required determine how to evaluate criteria against the field exists returns results if a person in the audience has the attribute eq returns results if the audience has the attribute and the attribute has the value you specify accepted values eq exists value string the value you want to match for this attribute you must include a value if you use the eq operator specify recipients with segments find your segment id you ll need the numerical id for each segment you d like to target this can be found in the ui by hovering over the segment info icon in the segment overview or on the individual segment page then you can use it to define or override recipients with json that looks like this data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information recipients segment id 3 using multiple segment ids here you ll need to format a boolean expression of segment ids in json like this recipients or segment id 3 segment id 4 this would target profiles that belong to either segment 7 or 8 use and if you d like to target profiles in both segments specify recipients with attributes in addition to segment ids you can also specify or override recipients with attribute conditions these accept two operators eq and exists note that you ll need to separate the operator and value into separate entries data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information recipients attribute field interest operator eq value roadrunners if you need an is not equal or does not exist condition use the not operator on an eq exists attribute condition here is an example with a not operator data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information recipients not attribute field interest operator eq value roadrunners combining segments and attributes alternately you can use a combination of segment and attribute conditions using the general syntax above here s an example of how to do that with some simple data to go with it data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information recipients and segment id 3 or attribute field interest operator eq value roadrunners attribute field state operator eq value nm not attribute field species operator eq value roadrunners recipient list in some situations it might be desirable to specify a list of recipients these can be provided either through a list of profile ids or a list of email addresses profile ids the list of profile ids is provided as a json array in the attribute ids you can send up to 10 000 ids in one api call sending more than that will result in an error is returned to the caller if any of the profile ids in this array do not correspond to an existing profile s id attribute in customer io then the trigger api returns an error to the caller unless the boolean attribute id_ignore_missing is set to true in which case the missing ids are ignored here s an example of how to do that with some simple data to go with it data headline roadrunner spotted in albuquerque date january 24 2018 text we ve received reports of a roadrunner in your immediate area head to your dashboard to view more information ids wiley roadrunner acme id_ignore_missing true email addresses the list of emails addresses is provided as a json array in the attribute emails you can send up to 10 000 emails in one api call sending more than that will result in an error is returned to the caller if any of the email addresses in this array do not correspond to an existing profile s email attribute in customer io then the trigger api returns an error to the caller unless the boolean attribute email_ignore_missing is set to true in which case missing emails are ignored if the data that you are sending contains customers that might not exist in customer io application then this is the attribute to use if any of the email addresses in this array corresponds to multiple profile ids the trigger api returns an error to the caller unless the boolean attribute email_add_duplicates is set to true in which case all matching customers are added as rec...
|
