Skip to content

Flows API

Get a flow action

GEThttps://email.growthdept.ai/api/flow-actions/{id}

Rate limits

Burst: 3/s

Steady: 60/m

Tier S. See rate limits for how requests are counted.

Scopes

flows:read

Operation id

get_flow_action The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of flow-action resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of flow-message resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Attributes of flow resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

array of strings

Related resources to side-load.

Includes guide

Pick values to add them to the request:

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

200Success

Response body

object

  • dataobjectrequired

    data: 5 fields
    • typestringrequired

      flow-action
    • idstringrequired

    • attributesobjectrequired

      attributes: 3 fields
      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • definitionone ofcan be null

        One option: ActionOutputSplitAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          action-output-split
        • linksobjectcan be null

          links: 2 fields
          • next_if_truestringcan be null

          • next_if_falsestringcan be null

        • dataobjectcan be null

          data: 1 field
          • action_output_filterobjectrequiredcan be null

            action_output_filter: 1 field
            • condition_groupsarray of objectsrequired

              condition_groups: 1 field
              • conditionsarray of objectsrequired

        One option: BackInStockDelayAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          back-in-stock-delay
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        One option: ConditionalBranchAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          conditional-split
        • linksobjectcan be null

          links: 2 fields
          • next_if_truestringcan be null

          • next_if_falsestringcan be null

        • dataobjectcan be null

          data: 1 field
          • profile_filterobjectrequiredcan be null

            profile_filter: 1 field
            • condition_groupsarray of objectsrequired

              condition_groups: 1 field
              • conditionsarray of objectsrequired

        One option: ContentExperimentAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          content-experiment
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectrequired

          data: 4 fields
          • statusstring

            disableddraftlivemanual
          • experiment_statusstringcan be null

            completeddraftlive
          • main_actionone ofrequired

            One option: SendPushNotificationAction
            • idstringcan be null

            • temporary_idstringcan be null

            • typestringrequired

              send-mobile-push
            • linksobjectcan be null

              links: 1 field
              • nextstringcan be null

            • dataobjectcan be null

              data: 2 fields
              • messageobjectcan be null

              • statusstring

                disableddraftlivemanual
            One option: SendWhatsAppAction
            • idstringcan be null

            • temporary_idstringcan be null

            • typestringrequired

              send-whatsapp
            • linksobjectcan be null

              links: 1 field
              • nextstringcan be null

            • dataobjectcan be null

              data: 2 fields
              • messageobjectcan be null

              • statusstring

                disableddraftlivemanual
          • current_experimentobjectcan be null

            current_experiment: 6 fields
            • idstringcan be null

            • namestringcan be null

            • variationsarray of objectsrequired

              One option: SendPushNotificationAction
              • idstringcan be null

              • temporary_idstringcan be null

              • typestringrequired

                send-mobile-push
              • linksobjectcan be null

              • dataobjectcan be null

              One option: SendWhatsAppAction
              • idstringcan be null

              • temporary_idstringcan be null

              • typestringrequired

                send-whatsapp
              • linksobjectcan be null

              • dataobjectcan be null

            • allocationsobjectcan be null

            • startedstring (date-time)can be null

            • winner_metricstringcan be null

              click-rateopen-rate
        One option: SendEmailAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-email
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectcan be null

            message: 15 fields
            • from_emailstringcan be null

            • from_labelstringcan be null

            • reply_to_emailstringcan be null

            • cc_emailstringcan be null

            • bcc_emailstringcan be null

            • subject_linestringcan be null

            • preview_textstringcan be null

            • template_idstringcan be null

            • smart_sending_enabledboolean

            • transactionalboolean

            • add_tracking_paramsboolean

            • custom_tracking_paramsarray of objectscan be null

              custom_tracking_params: 2 fields
              • paramstringrequired

              • valuestringrequired

            • additional_filtersobjectcan be null

              additional_filters: 1 field
              • condition_groupsarray of objectsrequired

            • namestringcan be null

            • idstringcan be null

          • statusstring

            disableddraftlivemanual
        One option: SendPushNotificationAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-mobile-push
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectcan be null

            message: 20 fields
            • titlestringcan be null

            • bodystringrequired

            • soundboolean

            • badgeboolean

            • badge_optionsone of

              One option: Increment
              • badge_configstringrequired

                increment_one
              One option: StaticCount
              • badge_configstringrequired

                set_count
              • valuestringrequired

              One option: Property
              • badge_configstringrequired

                set_property
              • set_from_propertystringrequired

            • image_idstringcan be null

            • dynamic_imagestringcan be null

            • video_asset_idstringcan be null

            • on_openstring

              homelinkopen_url
            • ios_linkstringcan be null

            • android_linkstringcan be null

            • web_urlstringcan be null

            • push_typestringcan be null

              silentstandard
            • kv_pairsobjectcan be null

            • conversion_metric_idstringcan be null

            • smart_sending_enabledboolean

            • additional_filtersobjectcan be null

              additional_filters: 1 field
              • condition_groupsarray of objectsrequired

            • action_buttonsarray of objectscan be null

              action_buttons: 8 fields
              • labelstringrequired

              • action_typestringrequired

                deep_linkdismissopen_appopen_url
              • positionintegercan be null

              • urlstringcan be null

              • iconstringcan be null

              • custom_action_idstringcan be null

              • ios_deep_linkstringcan be null

              • android_deep_linkstringcan be null

            • namestringcan be null

            • idstringcan be null

          • statusstring

            disableddraftlivemanual
        One option: SendSmsAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-sms
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectcan be null

            message: 18 fields
            • bodystringrequired

            • image_idstringcan be null

            • dynamic_imagestringcan be null

            • message_hierarchyarray of objectscan be null

              One option: MessageHierarchyRcsItem
              • messagestring

              • message_formatstring

                RCS
              • rich_contentobjectcan be null

              • extraobjectcan be null

              • imageobjectcan be null

              One option: MessageHierarchySmsItem
              • messagestringrequired

              • message_formatstring

                SMS
              • extraobjectcan be null

              • imageobjectcan be null

              • mediaobjectcan be null

            • shorten_linksboolean

            • include_contact_cardboolean

            • add_org_prefixboolean

            • add_info_linkboolean

            • add_opt_out_languageboolean

            • smart_sending_enabledboolean

            • sms_quiet_hours_enabledboolean

            • transactionalboolean

            • add_tracking_paramsboolean

            • custom_tracking_paramsarray of objectscan be null

              custom_tracking_params: 2 fields
              • paramstringrequired

              • valuestringrequired

            • template_idstringcan be null

            • additional_filtersobjectcan be null

              additional_filters: 1 field
              • condition_groupsarray of objectsrequired

            • namestringcan be null

            • idstringcan be null

          • statusstring

            disableddraftlivemanual
        One option: SendWebhookAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-webhook
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectrequired

            message: 5 fields
            • urlstringrequiredcan be null

            • headersobjectcan be null

            • bodystringcan be null

            • namestringcan be null

            • idstringcan be null

          • statusstring

            disableddraftlivemanual
        One option: SendInternalAlertAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-internal-alert
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectrequired

            message: 7 fields
            • from_emailstringrequiredcan be null

            • from_labelstringrequiredcan be null

            • to_emailsarray of stringsrequired

            • subject_linestringrequiredcan be null

            • template_idstringcan be null

            • namestringcan be null

            • idstringcan be null

          • statusstring

            disableddraftlivemanual
        One option: SendWhatsAppAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-whatsapp
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectcan be null

            message: 9 fields
            • idstringcan be null

            • namestringcan be null

            • vendor_idstringcan be null

            • smart_sending_enabledboolean

            • transactionalboolean

            • add_tracking_paramsboolean

            • additional_filtersobjectcan be null

              additional_filters: 1 field
              • condition_groupsarray of objectsrequired

            • automation_idstringcan be null

            • expiry_hoursintegercan be null

          • statusstring

            disableddraftlivemanual
        One option: SendWhatsAppWithACAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          send-whatsapp-with-ac
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • messageobjectcan be null

            message: 9 fields
            • idstringcan be null

            • namestringcan be null

            • vendor_idstringcan be null

            • smart_sending_enabledboolean

            • transactionalboolean

            • add_tracking_paramsboolean

            • additional_filtersobjectcan be null

              additional_filters: 1 field
              • condition_groupsarray of objectsrequired

            • automation_idstringcan be null

            • expiry_hoursintegercan be null

          • statusstring

            disableddraftlivemanual
        One option: TimeDelayAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          time-delay
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectrequired

          data: 6 fields
          • unitstring

            dayshoursminutes
          • valueintegerrequired

          • secondary_valueintegercan be null

          • timezonestring

            Show 434 allowed values
            Africa/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/MaseruAfrica/MbabaneAfrica/MogadishuAfrica/MonroviaAfrica/NairobiAfrica/NdjamenaAfrica/NiameyAfrica/NouakchottAfrica/OuagadougouAfrica/Porto-NovoAfrica/Sao_TomeAfrica/TripoliAfrica/TunisAfrica/WindhoekAmerica/AdakAmerica/AnchorageAmerica/AnguillaAmerica/AntiguaAmerica/AraguainaAmerica/Argentina/Buenos_AiresAmerica/Argentina/CatamarcaAmerica/Argentina/CordobaAmerica/Argentina/JujuyAmerica/Argentina/La_RiojaAmerica/Argentina/MendozaAmerica/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_JuanAmerica/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/UshuaiaAmerica/ArubaAmerica/AsuncionAmerica/AtikokanAmerica/BahiaAmerica/Bahia_BanderasAmerica/BarbadosAmerica/BelemAmerica/BelizeAmerica/Blanc-SablonAmerica/Boa_VistaAmerica/BogotaAmerica/BoiseAmerica/Cambridge_BayAmerica/Campo_GrandeAmerica/CancunAmerica/CaracasAmerica/CayenneAmerica/CaymanAmerica/ChicagoAmerica/ChihuahuaAmerica/Ciudad_JuarezAmerica/Costa_RicaAmerica/CoyhaiqueAmerica/CrestonAmerica/CuiabaAmerica/CuracaoAmerica/DanmarkshavnAmerica/DawsonAmerica/Dawson_CreekAmerica/DenverAmerica/DetroitAmerica/DominicaAmerica/EdmontonAmerica/EirunepeAmerica/El_SalvadorAmerica/Fort_NelsonAmerica/FortalezaAmerica/Glace_BayAmerica/Goose_BayAmerica/Grand_TurkAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/GuayaquilAmerica/GuyanaAmerica/HalifaxAmerica/HavanaAmerica/HermosilloAmerica/Indiana/IndianapolisAmerica/Indiana/KnoxAmerica/Indiana/MarengoAmerica/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/VevayAmerica/Indiana/VincennesAmerica/Indiana/WinamacAmerica/InuvikAmerica/IqaluitAmerica/JamaicaAmerica/JuneauAmerica/Kentucky/LouisvilleAmerica/Kentucky/MonticelloAmerica/KralendijkAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/Lower_PrincesAmerica/MaceioAmerica/ManaguaAmerica/ManausAmerica/MarigotAmerica/MartiniqueAmerica/MatamorosAmerica/MazatlanAmerica/MenomineeAmerica/MeridaAmerica/MetlakatlaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/NomeAmerica/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/CenterAmerica/North_Dakota/New_SalemAmerica/NuukAmerica/OjinagaAmerica/PanamaAmerica/ParamariboAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_ArenasAmerica/Rankin_InletAmerica/RecifeAmerica/ReginaAmerica/ResoluteAmerica/Rio_BrancoAmerica/SantaremAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ScoresbysundAmerica/SitkaAmerica/St_BarthelemyAmerica/St_JohnsAmerica/St_KittsAmerica/St_LuciaAmerica/St_ThomasAmerica/St_VincentAmerica/Swift_CurrentAmerica/TegucigalpaAmerica/ThuleAmerica/TijuanaAmerica/TorontoAmerica/TortolaAmerica/VancouverAmerica/WhitehorseAmerica/WinnipegAmerica/YakutatAntarctica/CaseyAntarctica/DavisAntarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/MawsonAntarctica/McMurdoAntarctica/PalmerAntarctica/RotheraAntarctica/SyowaAntarctica/TrollAntarctica/VostokArctic/LongyearbyenAsia/AdenAsia/AlmatyAsia/AmmanAsia/AnadyrAsia/AqtauAsia/AqtobeAsia/AshgabatAsia/AtyrauAsia/BaghdadAsia/BahrainAsia/BakuAsia/BangkokAsia/BarnaulAsia/BeirutAsia/BishkekAsia/BruneiAsia/ChitaAsia/ColomboAsia/DamascusAsia/DhakaAsia/DiliAsia/DubaiAsia/DushanbeAsia/FamagustaAsia/GazaAsia/HebronAsia/Ho_Chi_MinhAsia/Hong_KongAsia/HovdAsia/IrkutskAsia/JakartaAsia/JayapuraAsia/JerusalemAsia/KabulAsia/KamchatkaAsia/KarachiAsia/KathmanduAsia/KhandygaAsia/KolkataAsia/KrasnoyarskAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/MagadanAsia/MakassarAsia/ManilaAsia/MuscatAsia/NicosiaAsia/NovokuznetskAsia/NovosibirskAsia/OmskAsia/OralAsia/Phnom_PenhAsia/PontianakAsia/PyongyangAsia/QatarAsia/QostanayAsia/QyzylordaAsia/RiyadhAsia/SakhalinAsia/SamarkandAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/SrednekolymskAsia/TaipeiAsia/TashkentAsia/TbilisiAsia/TehranAsia/ThimphuAsia/TokyoAsia/TomskAsia/UlaanbaatarAsia/UrumqiAsia/Ust-NeraAsia/VientianeAsia/VladivostokAsia/YakutskAsia/YangonAsia/YekaterinburgAsia/YerevanAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaroeAtlantic/MadeiraAtlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_HelenaAtlantic/StanleyAustralia/AdelaideAustralia/BrisbaneAustralia/Broken_HillAustralia/DarwinAustralia/EuclaAustralia/HobartAustralia/LindemanAustralia/Lord_HoweAustralia/MelbourneAustralia/PerthAustralia/SydneyCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificEurope/AmsterdamEurope/AndorraEurope/AstrakhanEurope/AthensEurope/BelgradeEurope/BerlinEurope/BratislavaEurope/BrusselsEurope/BucharestEurope/BudapestEurope/BusingenEurope/ChisinauEurope/CopenhagenEurope/DublinEurope/GibraltarEurope/GuernseyEurope/HelsinkiEurope/Isle_of_ManEurope/IstanbulEurope/JerseyEurope/KaliningradEurope/KirovEurope/KyivEurope/LisbonEurope/LjubljanaEurope/LondonEurope/LuxembourgEurope/MadridEurope/MaltaEurope/MariehamnEurope/MinskEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PodgoricaEurope/PragueEurope/RigaEurope/RomeEurope/SamaraEurope/San_MarinoEurope/SarajevoEurope/SaratovEurope/SimferopolEurope/SkopjeEurope/SofiaEurope/StockholmEurope/TallinnEurope/TiraneEurope/UlyanovskEurope/VaduzEurope/VaticanEurope/ViennaEurope/VilniusEurope/VolgogradEurope/WarsawEurope/ZagrebEurope/ZurichGMTIndian/AntananarivoIndian/ChagosIndian/ChristmasIndian/CocosIndian/ComoroIndian/KerguelenIndian/MaheIndian/MaldivesIndian/MauritiusIndian/MayotteIndian/ReunionPacific/ApiaPacific/AucklandPacific/BougainvillePacific/ChathamPacific/ChuukPacific/EasterPacific/EfatePacific/FakaofoPacific/FijiPacific/FunafutiPacific/GalapagosPacific/GambierPacific/GuadalcanalPacific/GuamPacific/HonoluluPacific/KantonPacific/KiritimatiPacific/KosraePacific/KwajaleinPacific/MajuroPacific/MarquesasPacific/MidwayPacific/NauruPacific/NiuePacific/NorfolkPacific/NoumeaPacific/Pago_PagoPacific/PalauPacific/PitcairnPacific/PohnpeiPacific/Port_MoresbyPacific/RarotongaPacific/SaipanPacific/TahitiPacific/TarawaPacific/TongatapuPacific/WakePacific/WallisUS/AlaskaUS/ArizonaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificUTCprofile
          • delay_until_timestring (time)can be null

          • delay_until_weekdaysarray of stringscan be null

        One option: TriggerBranchAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          trigger-split
        • linksobjectcan be null

          links: 2 fields
          • next_if_truestringcan be null

          • next_if_falsestringcan be null

        • dataobjectcan be null

          data: 4 fields
          • trigger_filterobjectrequiredcan be null

            trigger_filter: 1 field
            • condition_groupsarray of objectsrequired

              condition_groups: 1 field
              • conditionsarray of objectsrequired

          • trigger_idstringrequired

          • trigger_typestringrequired

            datelistlow-inventorymetricprice-dropscheduledsegment
          • trigger_subtypestringcan be null

            custom-objectlegacy-custom-objectprofile-propertyprofile-trait
        One option: UpdateProfileAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          update-profile
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • profile_operationsarray of objectsrequired

            One option: ProfileOperationUpdateOrCreateString
            • operatorstringrequired

              createupdate
            • property_typestringrequired

              string
            • property_keystringrequired

            • property_valuestringrequired

            One option: ProfileOperationUpdateOrCreateBoolean
            • operatorstringrequired

              createupdate
            • property_typestringrequired

              boolean
            • property_keystringrequired

            • property_valuebooleanrequired

            One option: ProfileOperationUpdateOrCreateNumeric
            • operatorstringrequired

              createupdate
            • property_typestringrequired

              numeric
            • property_keystringrequired

            • property_valueone ofrequired

              One option: integer

              No fields.

              One option: number

              No fields.

            One option: ProfileOperationUpdateOrCreateDate
            • operatorstringrequired

              createupdate
            • property_typestringrequired

              date
            • property_keystringrequired

            • property_valueone ofrequired

              One option: string

              No fields.

              One option: string

              No fields.

            One option: ProfileOperationUpdateOrCreateList
            • operatorstringrequired

              createupdate
            • property_typestringrequired

              list
            • property_operationstringcan be null

              addremove
            • property_keystringrequired

            • property_valuestringrequired

            One option: ProfileOperationDelete
            • operatorstringrequired

              delete
            • property_keystringrequired

          • statusstring

            disableddraftlivemanual
        One option: TargetDateAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          target-date
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectrequired

          data: 3 fields
          • timezonestring

            Show 434 allowed values
            Africa/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/MaseruAfrica/MbabaneAfrica/MogadishuAfrica/MonroviaAfrica/NairobiAfrica/NdjamenaAfrica/NiameyAfrica/NouakchottAfrica/OuagadougouAfrica/Porto-NovoAfrica/Sao_TomeAfrica/TripoliAfrica/TunisAfrica/WindhoekAmerica/AdakAmerica/AnchorageAmerica/AnguillaAmerica/AntiguaAmerica/AraguainaAmerica/Argentina/Buenos_AiresAmerica/Argentina/CatamarcaAmerica/Argentina/CordobaAmerica/Argentina/JujuyAmerica/Argentina/La_RiojaAmerica/Argentina/MendozaAmerica/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_JuanAmerica/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/UshuaiaAmerica/ArubaAmerica/AsuncionAmerica/AtikokanAmerica/BahiaAmerica/Bahia_BanderasAmerica/BarbadosAmerica/BelemAmerica/BelizeAmerica/Blanc-SablonAmerica/Boa_VistaAmerica/BogotaAmerica/BoiseAmerica/Cambridge_BayAmerica/Campo_GrandeAmerica/CancunAmerica/CaracasAmerica/CayenneAmerica/CaymanAmerica/ChicagoAmerica/ChihuahuaAmerica/Ciudad_JuarezAmerica/Costa_RicaAmerica/CoyhaiqueAmerica/CrestonAmerica/CuiabaAmerica/CuracaoAmerica/DanmarkshavnAmerica/DawsonAmerica/Dawson_CreekAmerica/DenverAmerica/DetroitAmerica/DominicaAmerica/EdmontonAmerica/EirunepeAmerica/El_SalvadorAmerica/Fort_NelsonAmerica/FortalezaAmerica/Glace_BayAmerica/Goose_BayAmerica/Grand_TurkAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/GuayaquilAmerica/GuyanaAmerica/HalifaxAmerica/HavanaAmerica/HermosilloAmerica/Indiana/IndianapolisAmerica/Indiana/KnoxAmerica/Indiana/MarengoAmerica/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/VevayAmerica/Indiana/VincennesAmerica/Indiana/WinamacAmerica/InuvikAmerica/IqaluitAmerica/JamaicaAmerica/JuneauAmerica/Kentucky/LouisvilleAmerica/Kentucky/MonticelloAmerica/KralendijkAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/Lower_PrincesAmerica/MaceioAmerica/ManaguaAmerica/ManausAmerica/MarigotAmerica/MartiniqueAmerica/MatamorosAmerica/MazatlanAmerica/MenomineeAmerica/MeridaAmerica/MetlakatlaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/NomeAmerica/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/CenterAmerica/North_Dakota/New_SalemAmerica/NuukAmerica/OjinagaAmerica/PanamaAmerica/ParamariboAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_ArenasAmerica/Rankin_InletAmerica/RecifeAmerica/ReginaAmerica/ResoluteAmerica/Rio_BrancoAmerica/SantaremAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ScoresbysundAmerica/SitkaAmerica/St_BarthelemyAmerica/St_JohnsAmerica/St_KittsAmerica/St_LuciaAmerica/St_ThomasAmerica/St_VincentAmerica/Swift_CurrentAmerica/TegucigalpaAmerica/ThuleAmerica/TijuanaAmerica/TorontoAmerica/TortolaAmerica/VancouverAmerica/WhitehorseAmerica/WinnipegAmerica/YakutatAntarctica/CaseyAntarctica/DavisAntarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/MawsonAntarctica/McMurdoAntarctica/PalmerAntarctica/RotheraAntarctica/SyowaAntarctica/TrollAntarctica/VostokArctic/LongyearbyenAsia/AdenAsia/AlmatyAsia/AmmanAsia/AnadyrAsia/AqtauAsia/AqtobeAsia/AshgabatAsia/AtyrauAsia/BaghdadAsia/BahrainAsia/BakuAsia/BangkokAsia/BarnaulAsia/BeirutAsia/BishkekAsia/BruneiAsia/ChitaAsia/ColomboAsia/DamascusAsia/DhakaAsia/DiliAsia/DubaiAsia/DushanbeAsia/FamagustaAsia/GazaAsia/HebronAsia/Ho_Chi_MinhAsia/Hong_KongAsia/HovdAsia/IrkutskAsia/JakartaAsia/JayapuraAsia/JerusalemAsia/KabulAsia/KamchatkaAsia/KarachiAsia/KathmanduAsia/KhandygaAsia/KolkataAsia/KrasnoyarskAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/MagadanAsia/MakassarAsia/ManilaAsia/MuscatAsia/NicosiaAsia/NovokuznetskAsia/NovosibirskAsia/OmskAsia/OralAsia/Phnom_PenhAsia/PontianakAsia/PyongyangAsia/QatarAsia/QostanayAsia/QyzylordaAsia/RiyadhAsia/SakhalinAsia/SamarkandAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/SrednekolymskAsia/TaipeiAsia/TashkentAsia/TbilisiAsia/TehranAsia/ThimphuAsia/TokyoAsia/TomskAsia/UlaanbaatarAsia/UrumqiAsia/Ust-NeraAsia/VientianeAsia/VladivostokAsia/YakutskAsia/YangonAsia/YekaterinburgAsia/YerevanAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaroeAtlantic/MadeiraAtlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_HelenaAtlantic/StanleyAustralia/AdelaideAustralia/BrisbaneAustralia/Broken_HillAustralia/DarwinAustralia/EuclaAustralia/HobartAustralia/LindemanAustralia/Lord_HoweAustralia/MelbourneAustralia/PerthAustralia/SydneyCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificEurope/AmsterdamEurope/AndorraEurope/AstrakhanEurope/AthensEurope/BelgradeEurope/BerlinEurope/BratislavaEurope/BrusselsEurope/BucharestEurope/BudapestEurope/BusingenEurope/ChisinauEurope/CopenhagenEurope/DublinEurope/GibraltarEurope/GuernseyEurope/HelsinkiEurope/Isle_of_ManEurope/IstanbulEurope/JerseyEurope/KaliningradEurope/KirovEurope/KyivEurope/LisbonEurope/LjubljanaEurope/LondonEurope/LuxembourgEurope/MadridEurope/MaltaEurope/MariehamnEurope/MinskEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PodgoricaEurope/PragueEurope/RigaEurope/RomeEurope/SamaraEurope/San_MarinoEurope/SarajevoEurope/SaratovEurope/SimferopolEurope/SkopjeEurope/SofiaEurope/StockholmEurope/TallinnEurope/TiraneEurope/UlyanovskEurope/VaduzEurope/VaticanEurope/ViennaEurope/VilniusEurope/VolgogradEurope/WarsawEurope/ZagrebEurope/ZurichGMTIndian/AntananarivoIndian/ChagosIndian/ChristmasIndian/CocosIndian/ComoroIndian/KerguelenIndian/MaheIndian/MaldivesIndian/MauritiusIndian/MayotteIndian/ReunionPacific/ApiaPacific/AucklandPacific/BougainvillePacific/ChathamPacific/ChuukPacific/EasterPacific/EfatePacific/FakaofoPacific/FijiPacific/FunafutiPacific/GalapagosPacific/GambierPacific/GuadalcanalPacific/GuamPacific/HonoluluPacific/KantonPacific/KiritimatiPacific/KosraePacific/KwajaleinPacific/MajuroPacific/MarquesasPacific/MidwayPacific/NauruPacific/NiuePacific/NorfolkPacific/NoumeaPacific/Pago_PagoPacific/PalauPacific/PitcairnPacific/PohnpeiPacific/Port_MoresbyPacific/RarotongaPacific/SaipanPacific/TahitiPacific/TarawaPacific/TongatapuPacific/WakePacific/WallisUS/AlaskaUS/ArizonaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificUTCprofile
          • target_timestring (time)

          • target_daysarray of stringscan be null

        One option: CountdownDelayAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          countdown-delay
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectrequired

          data: 5 fields
          • unitstring

            daysmonthsweeks
          • valueinteger

          • timezonestring

            Show 434 allowed values
            Africa/AbidjanAfrica/AccraAfrica/Addis_AbabaAfrica/AlgiersAfrica/AsmaraAfrica/BamakoAfrica/BanguiAfrica/BanjulAfrica/BissauAfrica/BlantyreAfrica/BrazzavilleAfrica/BujumburaAfrica/CairoAfrica/CasablancaAfrica/CeutaAfrica/ConakryAfrica/DakarAfrica/Dar_es_SalaamAfrica/DjiboutiAfrica/DoualaAfrica/El_AaiunAfrica/FreetownAfrica/GaboroneAfrica/HarareAfrica/JohannesburgAfrica/JubaAfrica/KampalaAfrica/KhartoumAfrica/KigaliAfrica/KinshasaAfrica/LagosAfrica/LibrevilleAfrica/LomeAfrica/LuandaAfrica/LubumbashiAfrica/LusakaAfrica/MalaboAfrica/MaputoAfrica/MaseruAfrica/MbabaneAfrica/MogadishuAfrica/MonroviaAfrica/NairobiAfrica/NdjamenaAfrica/NiameyAfrica/NouakchottAfrica/OuagadougouAfrica/Porto-NovoAfrica/Sao_TomeAfrica/TripoliAfrica/TunisAfrica/WindhoekAmerica/AdakAmerica/AnchorageAmerica/AnguillaAmerica/AntiguaAmerica/AraguainaAmerica/Argentina/Buenos_AiresAmerica/Argentina/CatamarcaAmerica/Argentina/CordobaAmerica/Argentina/JujuyAmerica/Argentina/La_RiojaAmerica/Argentina/MendozaAmerica/Argentina/Rio_GallegosAmerica/Argentina/SaltaAmerica/Argentina/San_JuanAmerica/Argentina/San_LuisAmerica/Argentina/TucumanAmerica/Argentina/UshuaiaAmerica/ArubaAmerica/AsuncionAmerica/AtikokanAmerica/BahiaAmerica/Bahia_BanderasAmerica/BarbadosAmerica/BelemAmerica/BelizeAmerica/Blanc-SablonAmerica/Boa_VistaAmerica/BogotaAmerica/BoiseAmerica/Cambridge_BayAmerica/Campo_GrandeAmerica/CancunAmerica/CaracasAmerica/CayenneAmerica/CaymanAmerica/ChicagoAmerica/ChihuahuaAmerica/Ciudad_JuarezAmerica/Costa_RicaAmerica/CoyhaiqueAmerica/CrestonAmerica/CuiabaAmerica/CuracaoAmerica/DanmarkshavnAmerica/DawsonAmerica/Dawson_CreekAmerica/DenverAmerica/DetroitAmerica/DominicaAmerica/EdmontonAmerica/EirunepeAmerica/El_SalvadorAmerica/Fort_NelsonAmerica/FortalezaAmerica/Glace_BayAmerica/Goose_BayAmerica/Grand_TurkAmerica/GrenadaAmerica/GuadeloupeAmerica/GuatemalaAmerica/GuayaquilAmerica/GuyanaAmerica/HalifaxAmerica/HavanaAmerica/HermosilloAmerica/Indiana/IndianapolisAmerica/Indiana/KnoxAmerica/Indiana/MarengoAmerica/Indiana/PetersburgAmerica/Indiana/Tell_CityAmerica/Indiana/VevayAmerica/Indiana/VincennesAmerica/Indiana/WinamacAmerica/InuvikAmerica/IqaluitAmerica/JamaicaAmerica/JuneauAmerica/Kentucky/LouisvilleAmerica/Kentucky/MonticelloAmerica/KralendijkAmerica/La_PazAmerica/LimaAmerica/Los_AngelesAmerica/Lower_PrincesAmerica/MaceioAmerica/ManaguaAmerica/ManausAmerica/MarigotAmerica/MartiniqueAmerica/MatamorosAmerica/MazatlanAmerica/MenomineeAmerica/MeridaAmerica/MetlakatlaAmerica/Mexico_CityAmerica/MiquelonAmerica/MonctonAmerica/MonterreyAmerica/MontevideoAmerica/MontserratAmerica/NassauAmerica/New_YorkAmerica/NomeAmerica/NoronhaAmerica/North_Dakota/BeulahAmerica/North_Dakota/CenterAmerica/North_Dakota/New_SalemAmerica/NuukAmerica/OjinagaAmerica/PanamaAmerica/ParamariboAmerica/PhoenixAmerica/Port-au-PrinceAmerica/Port_of_SpainAmerica/Porto_VelhoAmerica/Puerto_RicoAmerica/Punta_ArenasAmerica/Rankin_InletAmerica/RecifeAmerica/ReginaAmerica/ResoluteAmerica/Rio_BrancoAmerica/SantaremAmerica/SantiagoAmerica/Santo_DomingoAmerica/Sao_PauloAmerica/ScoresbysundAmerica/SitkaAmerica/St_BarthelemyAmerica/St_JohnsAmerica/St_KittsAmerica/St_LuciaAmerica/St_ThomasAmerica/St_VincentAmerica/Swift_CurrentAmerica/TegucigalpaAmerica/ThuleAmerica/TijuanaAmerica/TorontoAmerica/TortolaAmerica/VancouverAmerica/WhitehorseAmerica/WinnipegAmerica/YakutatAntarctica/CaseyAntarctica/DavisAntarctica/DumontDUrvilleAntarctica/MacquarieAntarctica/MawsonAntarctica/McMurdoAntarctica/PalmerAntarctica/RotheraAntarctica/SyowaAntarctica/TrollAntarctica/VostokArctic/LongyearbyenAsia/AdenAsia/AlmatyAsia/AmmanAsia/AnadyrAsia/AqtauAsia/AqtobeAsia/AshgabatAsia/AtyrauAsia/BaghdadAsia/BahrainAsia/BakuAsia/BangkokAsia/BarnaulAsia/BeirutAsia/BishkekAsia/BruneiAsia/ChitaAsia/ColomboAsia/DamascusAsia/DhakaAsia/DiliAsia/DubaiAsia/DushanbeAsia/FamagustaAsia/GazaAsia/HebronAsia/Ho_Chi_MinhAsia/Hong_KongAsia/HovdAsia/IrkutskAsia/JakartaAsia/JayapuraAsia/JerusalemAsia/KabulAsia/KamchatkaAsia/KarachiAsia/KathmanduAsia/KhandygaAsia/KolkataAsia/KrasnoyarskAsia/Kuala_LumpurAsia/KuchingAsia/KuwaitAsia/MacauAsia/MagadanAsia/MakassarAsia/ManilaAsia/MuscatAsia/NicosiaAsia/NovokuznetskAsia/NovosibirskAsia/OmskAsia/OralAsia/Phnom_PenhAsia/PontianakAsia/PyongyangAsia/QatarAsia/QostanayAsia/QyzylordaAsia/RiyadhAsia/SakhalinAsia/SamarkandAsia/SeoulAsia/ShanghaiAsia/SingaporeAsia/SrednekolymskAsia/TaipeiAsia/TashkentAsia/TbilisiAsia/TehranAsia/ThimphuAsia/TokyoAsia/TomskAsia/UlaanbaatarAsia/UrumqiAsia/Ust-NeraAsia/VientianeAsia/VladivostokAsia/YakutskAsia/YangonAsia/YekaterinburgAsia/YerevanAtlantic/AzoresAtlantic/BermudaAtlantic/CanaryAtlantic/Cape_VerdeAtlantic/FaroeAtlantic/MadeiraAtlantic/ReykjavikAtlantic/South_GeorgiaAtlantic/St_HelenaAtlantic/StanleyAustralia/AdelaideAustralia/BrisbaneAustralia/Broken_HillAustralia/DarwinAustralia/EuclaAustralia/HobartAustralia/LindemanAustralia/Lord_HoweAustralia/MelbourneAustralia/PerthAustralia/SydneyCanada/AtlanticCanada/CentralCanada/EasternCanada/MountainCanada/NewfoundlandCanada/PacificEurope/AmsterdamEurope/AndorraEurope/AstrakhanEurope/AthensEurope/BelgradeEurope/BerlinEurope/BratislavaEurope/BrusselsEurope/BucharestEurope/BudapestEurope/BusingenEurope/ChisinauEurope/CopenhagenEurope/DublinEurope/GibraltarEurope/GuernseyEurope/HelsinkiEurope/Isle_of_ManEurope/IstanbulEurope/JerseyEurope/KaliningradEurope/KirovEurope/KyivEurope/LisbonEurope/LjubljanaEurope/LondonEurope/LuxembourgEurope/MadridEurope/MaltaEurope/MariehamnEurope/MinskEurope/MonacoEurope/MoscowEurope/OsloEurope/ParisEurope/PodgoricaEurope/PragueEurope/RigaEurope/RomeEurope/SamaraEurope/San_MarinoEurope/SarajevoEurope/SaratovEurope/SimferopolEurope/SkopjeEurope/SofiaEurope/StockholmEurope/TallinnEurope/TiraneEurope/UlyanovskEurope/VaduzEurope/VaticanEurope/ViennaEurope/VilniusEurope/VolgogradEurope/WarsawEurope/ZagrebEurope/ZurichGMTIndian/AntananarivoIndian/ChagosIndian/ChristmasIndian/CocosIndian/ComoroIndian/KerguelenIndian/MaheIndian/MaldivesIndian/MauritiusIndian/MayotteIndian/ReunionPacific/ApiaPacific/AucklandPacific/BougainvillePacific/ChathamPacific/ChuukPacific/EasterPacific/EfatePacific/FakaofoPacific/FijiPacific/FunafutiPacific/GalapagosPacific/GambierPacific/GuadalcanalPacific/GuamPacific/HonoluluPacific/KantonPacific/KiritimatiPacific/KosraePacific/KwajaleinPacific/MajuroPacific/MarquesasPacific/MidwayPacific/NauruPacific/NiuePacific/NorfolkPacific/NoumeaPacific/Pago_PagoPacific/PalauPacific/PitcairnPacific/PohnpeiPacific/Port_MoresbyPacific/RarotongaPacific/SaipanPacific/TahitiPacific/TarawaPacific/TongatapuPacific/WakePacific/WallisUS/AlaskaUS/ArizonaUS/CentralUS/EasternUS/HawaiiUS/MountainUS/PacificUTCprofile
          • delay_until_timestring (time)can be null

          • delay_until_weekdaysarray of stringscan be null

        One option: AbTestAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          ab-test
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectrequired

          data: 6 fields
          • statusstring

            disableddraftlivemanual
          • experiment_statusstring

            completeddraftlive
          • main_actionone ofrequired

            One option: SendEmailAction
            • idstringcan be null

            • temporary_idstringcan be null

            • typestringrequired

              send-email
            • linksobjectcan be null

              links: 1 field
              • nextstringcan be null

            • dataobjectcan be null

              data: 2 fields
              • messageobjectcan be null

              • statusstring

                disableddraftlivemanual
            One option: SendSmsAction
            • idstringcan be null

            • temporary_idstringcan be null

            • typestringrequired

              send-sms
            • linksobjectcan be null

              links: 1 field
              • nextstringcan be null

            • dataobjectcan be null

              data: 2 fields
              • messageobjectcan be null

              • statusstring

                disableddraftlivemanual
          • current_experimentobjectcan be null

            current_experiment: 7 fields
            • idstringcan be null

            • namestringcan be null

            • variationsarray of objectsrequired

              One option: SendEmailAction
              • idstringcan be null

              • temporary_idstringcan be null

              • typestringrequired

                send-email
              • linksobjectcan be null

              • dataobjectcan be null

              One option: SendSmsAction
              • idstringcan be null

              • temporary_idstringcan be null

              • typestringrequired

                send-sms
              • linksobjectcan be null

              • dataobjectcan be null

            • allocationsobjectcan be null

            • startedstring (date-time)can be null

            • winner_metricstringcan be null

              submissionunique-clicksunique-opensunique-placed-orders
            • automatic_winner_selection_settingsobjectcan be null

              automatic_winner_selection_settings: 3 fields
              • enabledbooleanrequired

              • automatic_end_datestring (date-time)can be null

              • automatic_end_statistical_certaintybooleanrequired

          • concluded_experiment_idstringcan be null

          • winning_variation_idstringcan be null

        One option: InternalServiceAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          internal-service
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • service_configurationone ofcan be null

            One option: InternalScheduledReportData
            • service_method_typestringrequired

              schedule-report
            • report_idstringrequired

            One option: InternalTrackEventData
            • service_method_typestringrequired

              track-event
            • event_keystringcan be null

            • event_payloadobjectcan be null

            • tracking_company_idstringcan be null

            One option: InternalScheduledReportBuilderReportData
            • service_method_typestringrequired

              schedule-report-builder-report
            • report_idstringrequired

            One option: InternalUnknownServiceData
            • service_method_typestringrequired

              unknown
          • statusstring

            disableddraftlivemanual
        One option: CodeAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          code
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

        • dataobjectcan be null

          data: 2 fields
          • namestringcan be null

          • code_function_idstringcan be null

        One option: MultiBranchSplitAction
        • idstringcan be null

        • temporary_idstringcan be null

        • typestringrequired

          multi-branch-split
        • linksobjectcan be null

        • dataobjectcan be null

          data: 2 fields
          • branchesarray of objectsrequired

            branches: 6 fields
            • branch_idstringrequired

            • orderintegercan be null

            • is_elseboolean

            • branch_filterobjectcan be null

              branch_filter: 1 field
              • condition_groupsarray of objectsrequired

            • linksobjectcan be null

              links: 1 field
              • nextstringcan be null

            • namestringcan be null

          • namestringrequired

        One option: ListUpdateAction
        • idstringcan be null

        • temporary_idstringcan be null

        • dataobjectrequired

          data: 4 fields
          • namestringrequired

          • on_executionbooleanrequiredcan be null

            falsetrue
          • list_idstringrequiredcan be null

          • statusstring

            disableddraftlivemanual
        • typestringrequired

          list-update
        • linksobjectcan be null

          links: 1 field
          • nextstringcan be null

    • relationshipsobject

      relationships: 2 fields
      • flowobject

        flow: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • flow-messagesobject

        flow-messages: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow-message
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • includedarray of objects

    One option: FlowResponseObjectResource
    • typestringrequired

      flow
    • idstringrequired

    • attributesobjectrequired

      attributes: 6 fields
      • namestringcan be null

      • statusstringcan be null

      • archivedbooleancan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • trigger_typestringcan be null

        Added to ListDate BasedLow InventoryMetricPrice DropUnconfigured
    • relationshipsobject

      relationships: 2 fields
      • flow-actionsobject

        flow-actions: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            flow-action
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • tagsobject

        tags: 2 fields
        • dataarray of objects

          data: 2 fields
          • typestringrequired

            tag
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

    One option: FlowMessageEncodedResponseObjectResource
    • typestringrequired

      flow-message
    • idstringrequired

    • attributesobjectrequired

      attributes: 4 fields
      • channelstringcan be null

      • createdstring (date-time)can be null

      • updatedstring (date-time)can be null

      • definitionone ofcan be null

        One option: FlowEmail
        • from_emailstringcan be null

        • from_labelstringcan be null

        • reply_to_emailstringcan be null

        • cc_emailstringcan be null

        • bcc_emailstringcan be null

        • subject_linestringcan be null

        • preview_textstringcan be null

        • template_idstringcan be null

        • smart_sending_enabledboolean

        • transactionalboolean

        • add_tracking_paramsboolean

        • custom_tracking_paramsarray of objectscan be null

          custom_tracking_params: 2 fields
          • paramstringrequired

          • valuestringrequired

        • additional_filtersobjectcan be null

          additional_filters: 1 field
          • condition_groupsarray of objectsrequired

            condition_groups: 1 field
            • conditionsarray of objectsrequired

              One option: ProfilePropertyCondition
              • typestringrequired

                profile-property
              • propertystringrequired

              • filterobjectrequired

              One option: ProfileHasGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                true
              • group_idsarray of stringsrequired

              • timeframe_filterobjectcan be null

              One option: ProfileNoGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                false
              • group_idsarray of stringsrequired

              One option: ProfileRegionCondition
              • typestringrequired

                profile-region
              • in_regionbooleanrequired

              • regionstringrequired

                european_unionunited_states
              One option: ProfilePostalCodeDistanceCondition
              • typestringrequired

                profile-postal-code-distance
              • country_codestringrequired

              • postal_codestringrequired

              • unitstringrequired

                kilometersmiles
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsDateCondition
              • dimensionstringrequired

                expected_date_of_next_purchase
              • filterobjectrequired

              • typestringrequired

                profile-predictive-analytics
              One option: ProfilePredictiveAnalyticsStringCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                predicted_gender
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsNumericCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                priority
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                rank
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfileMarketingConsentCondition
              • typestringrequired

                profile-marketing-consent
              • consentobjectrequired

              One option: FlowsProfileMetricCondition
              • typestringrequired

                profile-metric
              • metric_idstringrequired

              • measurementstringrequired

                countsum
              • measurement_filterobjectrequired

              • timeframe_filterobjectrequired

              • metric_filtersarray of objectscan be null

              One option: ProfileRandomSampleCondition
              • typestringrequired

                profile-sample
              • percentageintegerrequired

              One option: ProfileHasCustomObjectCondition
              • typestringrequired

                profile-has-custom-object
              • object_type_idstringrequired

              • object_type_relationship_idstringrequired

              • filterobjectrequired

              • filtersarray of objectsrequired

              One option: ProfilePermissionsCondition
              • typestringrequired

                profile-permissions
              • permissionobjectrequired

              • channelstringrequired

                email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
              One option: ProfileHasNotReceivedEmailMessageCondition
              • typestringrequired

                profile-not-sent-email
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedSmsMessageCondition
              • typestringrequired

                profile-not-sent-sms
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedPushMessageCondition
              • typestringrequired

                profile-not-sent-push
              • timeframe_filterobjectrequired

        • namestringcan be null

        • idstringcan be null

        One option: FlowInternalAlert
        • from_emailstringrequiredcan be null

        • from_labelstringrequiredcan be null

        • to_emailsarray of stringsrequired

        • subject_linestringrequiredcan be null

        • template_idstringcan be null

        • namestringcan be null

        • idstringcan be null

        One option: FlowPushNotification
        • titlestringcan be null

        • bodystringrequired

        • soundboolean

        • badgeboolean

        • badge_optionsone of

          One option: Increment
          • badge_configstringrequired

            increment_one
          One option: StaticCount
          • badge_configstringrequired

            set_count
          • valuestringrequired

          One option: Property
          • badge_configstringrequired

            set_property
          • set_from_propertystringrequired

        • image_idstringcan be null

        • dynamic_imagestringcan be null

        • video_asset_idstringcan be null

        • on_openstring

          homelinkopen_url
        • ios_linkstringcan be null

        • android_linkstringcan be null

        • web_urlstringcan be null

        • push_typestringcan be null

          silentstandard
        • kv_pairsobjectcan be null

        • conversion_metric_idstringcan be null

        • smart_sending_enabledboolean

        • additional_filtersobjectcan be null

          additional_filters: 1 field
          • condition_groupsarray of objectsrequired

            condition_groups: 1 field
            • conditionsarray of objectsrequired

              One option: ProfilePropertyCondition
              • typestringrequired

                profile-property
              • propertystringrequired

              • filterobjectrequired

              One option: ProfileHasGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                true
              • group_idsarray of stringsrequired

              • timeframe_filterobjectcan be null

              One option: ProfileNoGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                false
              • group_idsarray of stringsrequired

              One option: ProfileRegionCondition
              • typestringrequired

                profile-region
              • in_regionbooleanrequired

              • regionstringrequired

                european_unionunited_states
              One option: ProfilePostalCodeDistanceCondition
              • typestringrequired

                profile-postal-code-distance
              • country_codestringrequired

              • postal_codestringrequired

              • unitstringrequired

                kilometersmiles
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsDateCondition
              • dimensionstringrequired

                expected_date_of_next_purchase
              • filterobjectrequired

              • typestringrequired

                profile-predictive-analytics
              One option: ProfilePredictiveAnalyticsStringCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                predicted_gender
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsNumericCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                priority
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                rank
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfileMarketingConsentCondition
              • typestringrequired

                profile-marketing-consent
              • consentobjectrequired

              One option: FlowsProfileMetricCondition
              • typestringrequired

                profile-metric
              • metric_idstringrequired

              • measurementstringrequired

                countsum
              • measurement_filterobjectrequired

              • timeframe_filterobjectrequired

              • metric_filtersarray of objectscan be null

              One option: ProfileRandomSampleCondition
              • typestringrequired

                profile-sample
              • percentageintegerrequired

              One option: ProfileHasCustomObjectCondition
              • typestringrequired

                profile-has-custom-object
              • object_type_idstringrequired

              • object_type_relationship_idstringrequired

              • filterobjectrequired

              • filtersarray of objectsrequired

              One option: ProfilePermissionsCondition
              • typestringrequired

                profile-permissions
              • permissionobjectrequired

              • channelstringrequired

                email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
              One option: ProfileHasNotReceivedEmailMessageCondition
              • typestringrequired

                profile-not-sent-email
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedSmsMessageCondition
              • typestringrequired

                profile-not-sent-sms
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedPushMessageCondition
              • typestringrequired

                profile-not-sent-push
              • timeframe_filterobjectrequired

        • action_buttonsarray of objectscan be null

          action_buttons: 8 fields
          • labelstringrequired

          • action_typestringrequired

            deep_linkdismissopen_appopen_url
          • positionintegercan be null

          • urlstringcan be null

          • iconstringcan be null

          • custom_action_idstringcan be null

          • ios_deep_linkstringcan be null

          • android_deep_linkstringcan be null

        • namestringcan be null

        • idstringcan be null

        One option: FlowSms
        • bodystringrequired

        • image_idstringcan be null

        • dynamic_imagestringcan be null

        • message_hierarchyarray of objectscan be null

          One option: MessageHierarchyRcsItem
          • messagestring

          • message_formatstring

            RCS
          • rich_contentobjectcan be null

            rich_content: 3 fields
            • cardsarray of objectscan be null

              cards: 7 fields
              • idstringrequired

              • titlestringcan be null

              • textstringcan be null

              • extraobjectcan be null

              • imageobjectcan be null

              • videoobjectcan be null

              • buttonsarray of objectscan be null

            • suggestionsarray of objectscan be null

              suggestions: 5 fields
              • idstringrequired

              • textstringrequired

              • typestringrequired

                OPEN_URLREPLY
              • urlstringcan be null

              • open_modestringcan be null

                BROWSERWEBVIEW_FULLWEBVIEW_HALFWEBVIEW_TALL
            • fileobjectcan be null

              file: 3 fields
              • static_asset_idstringcan be null

              • dynamic_templatestringcan be null

              • thumbnailobjectcan be null

          • extraobjectcan be null

          • imageobjectcan be null

            image: 3 fields
            • static_image_asset_idintegercan be null

            • dynamic_image_templatestringcan be null

            • rendered_asset_urlstringcan be null

          One option: MessageHierarchySmsItem
          • messagestringrequired

          • message_formatstring

            SMS
          • extraobjectcan be null

          • imageone ofcan be null

            One option: StaticSMSImage
            • dynamicbooleancan be null

              false
            • static_image_asset_idintegerrequired

            One option: DynamicSMSImage
            • dynamicboolean

              true
            • dynamic_image_templatestringrequired

          • mediaone ofcan be null

            One option: MediaAsset
            • idstringrequired

            • company_idstringrequired

            • urlstringrequired

            • media_typestring

            • namestringrequired

            • file_sizeintegerrequired

            • thumbnail_urlstringcan be null

            • l10n_keystringcan be null

            One option: MediaAssetReference
            • static_asset_idstringcan be null

            • dynamic_templatestringcan be null

            • thumbnailobjectcan be null

              thumbnail: 3 fields
              • static_image_asset_idintegercan be null

              • dynamic_image_templatestringcan be null

              • rendered_asset_urlstringcan be null

        • shorten_linksboolean

        • include_contact_cardboolean

        • add_org_prefixboolean

        • add_info_linkboolean

        • add_opt_out_languageboolean

        • smart_sending_enabledboolean

        • sms_quiet_hours_enabledboolean

        • transactionalboolean

        • add_tracking_paramsboolean

        • custom_tracking_paramsarray of objectscan be null

          custom_tracking_params: 2 fields
          • paramstringrequired

          • valuestringrequired

        • template_idstringcan be null

        • additional_filtersobjectcan be null

          additional_filters: 1 field
          • condition_groupsarray of objectsrequired

            condition_groups: 1 field
            • conditionsarray of objectsrequired

              One option: ProfilePropertyCondition
              • typestringrequired

                profile-property
              • propertystringrequired

              • filterobjectrequired

              One option: ProfileHasGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                true
              • group_idsarray of stringsrequired

              • timeframe_filterobjectcan be null

              One option: ProfileNoGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                false
              • group_idsarray of stringsrequired

              One option: ProfileRegionCondition
              • typestringrequired

                profile-region
              • in_regionbooleanrequired

              • regionstringrequired

                european_unionunited_states
              One option: ProfilePostalCodeDistanceCondition
              • typestringrequired

                profile-postal-code-distance
              • country_codestringrequired

              • postal_codestringrequired

              • unitstringrequired

                kilometersmiles
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsDateCondition
              • dimensionstringrequired

                expected_date_of_next_purchase
              • filterobjectrequired

              • typestringrequired

                profile-predictive-analytics
              One option: ProfilePredictiveAnalyticsStringCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                predicted_gender
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsNumericCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                priority
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                rank
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfileMarketingConsentCondition
              • typestringrequired

                profile-marketing-consent
              • consentobjectrequired

              One option: FlowsProfileMetricCondition
              • typestringrequired

                profile-metric
              • metric_idstringrequired

              • measurementstringrequired

                countsum
              • measurement_filterobjectrequired

              • timeframe_filterobjectrequired

              • metric_filtersarray of objectscan be null

              One option: ProfileRandomSampleCondition
              • typestringrequired

                profile-sample
              • percentageintegerrequired

              One option: ProfileHasCustomObjectCondition
              • typestringrequired

                profile-has-custom-object
              • object_type_idstringrequired

              • object_type_relationship_idstringrequired

              • filterobjectrequired

              • filtersarray of objectsrequired

              One option: ProfilePermissionsCondition
              • typestringrequired

                profile-permissions
              • permissionobjectrequired

              • channelstringrequired

                email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
              One option: ProfileHasNotReceivedEmailMessageCondition
              • typestringrequired

                profile-not-sent-email
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedSmsMessageCondition
              • typestringrequired

                profile-not-sent-sms
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedPushMessageCondition
              • typestringrequired

                profile-not-sent-push
              • timeframe_filterobjectrequired

        • namestringcan be null

        • idstringcan be null

        One option: FlowWebhook
        • urlstringrequiredcan be null

        • headersobjectcan be null

        • bodystringcan be null

        • namestringcan be null

        • idstringcan be null

        One option: FlowWhatsApp
        • idstringcan be null

        • namestringcan be null

        • vendor_idstringcan be null

        • smart_sending_enabledboolean

        • transactionalboolean

        • add_tracking_paramsboolean

        • additional_filtersobjectcan be null

          additional_filters: 1 field
          • condition_groupsarray of objectsrequired

            condition_groups: 1 field
            • conditionsarray of objectsrequired

              One option: ProfilePropertyCondition
              • typestringrequired

                profile-property
              • propertystringrequired

              • filterobjectrequired

              One option: ProfileHasGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                true
              • group_idsarray of stringsrequired

              • timeframe_filterobjectcan be null

              One option: ProfileNoGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                false
              • group_idsarray of stringsrequired

              One option: ProfileRegionCondition
              • typestringrequired

                profile-region
              • in_regionbooleanrequired

              • regionstringrequired

                european_unionunited_states
              One option: ProfilePostalCodeDistanceCondition
              • typestringrequired

                profile-postal-code-distance
              • country_codestringrequired

              • postal_codestringrequired

              • unitstringrequired

                kilometersmiles
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsDateCondition
              • dimensionstringrequired

                expected_date_of_next_purchase
              • filterobjectrequired

              • typestringrequired

                profile-predictive-analytics
              One option: ProfilePredictiveAnalyticsStringCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                predicted_gender
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsNumericCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                priority
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                rank
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfileMarketingConsentCondition
              • typestringrequired

                profile-marketing-consent
              • consentobjectrequired

              One option: FlowsProfileMetricCondition
              • typestringrequired

                profile-metric
              • metric_idstringrequired

              • measurementstringrequired

                countsum
              • measurement_filterobjectrequired

              • timeframe_filterobjectrequired

              • metric_filtersarray of objectscan be null

              One option: ProfileRandomSampleCondition
              • typestringrequired

                profile-sample
              • percentageintegerrequired

              One option: ProfileHasCustomObjectCondition
              • typestringrequired

                profile-has-custom-object
              • object_type_idstringrequired

              • object_type_relationship_idstringrequired

              • filterobjectrequired

              • filtersarray of objectsrequired

              One option: ProfilePermissionsCondition
              • typestringrequired

                profile-permissions
              • permissionobjectrequired

              • channelstringrequired

                email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
              One option: ProfileHasNotReceivedEmailMessageCondition
              • typestringrequired

                profile-not-sent-email
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedSmsMessageCondition
              • typestringrequired

                profile-not-sent-sms
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedPushMessageCondition
              • typestringrequired

                profile-not-sent-push
              • timeframe_filterobjectrequired

        • automation_idstringcan be null

        • expiry_hoursintegercan be null

        One option: FlowWhatsAppWithAC
        • idstringcan be null

        • namestringcan be null

        • vendor_idstringcan be null

        • smart_sending_enabledboolean

        • transactionalboolean

        • add_tracking_paramsboolean

        • additional_filtersobjectcan be null

          additional_filters: 1 field
          • condition_groupsarray of objectsrequired

            condition_groups: 1 field
            • conditionsarray of objectsrequired

              One option: ProfilePropertyCondition
              • typestringrequired

                profile-property
              • propertystringrequired

              • filterobjectrequired

              One option: ProfileHasGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                true
              • group_idsarray of stringsrequired

              • timeframe_filterobjectcan be null

              One option: ProfileNoGroupMembershipCondition
              • typestringrequired

                profile-group-membership
              • is_memberbooleanrequired

                false
              • group_idsarray of stringsrequired

              One option: ProfileRegionCondition
              • typestringrequired

                profile-region
              • in_regionbooleanrequired

              • regionstringrequired

                european_unionunited_states
              One option: ProfilePostalCodeDistanceCondition
              • typestringrequired

                profile-postal-code-distance
              • country_codestringrequired

              • postal_codestringrequired

              • unitstringrequired

                kilometersmiles
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsDateCondition
              • dimensionstringrequired

                expected_date_of_next_purchase
              • filterobjectrequired

              • typestringrequired

                profile-predictive-analytics
              One option: ProfilePredictiveAnalyticsStringCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                predicted_gender
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsNumericCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                average_days_between_ordersaverage_order_valuechurn_probabilityhistoric_clvhistoric_number_of_orderspredicted_clvpredicted_number_of_orderstotal_clv
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityPriorityCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                priority
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfilePredictiveAnalyticsChannelAffinityRankCondition
              • typestringrequired

                profile-predictive-analytics
              • dimensionstringrequired

                channel_affinity
              • measurementstringrequired

                rank
              • predicted_channelstringrequired

                emailpushsmswhatsapp
              • filterobjectrequired

              One option: ProfileMarketingConsentCondition
              • typestringrequired

                profile-marketing-consent
              • consentobjectrequired

              One option: FlowsProfileMetricCondition
              • typestringrequired

                profile-metric
              • metric_idstringrequired

              • measurementstringrequired

                countsum
              • measurement_filterobjectrequired

              • timeframe_filterobjectrequired

              • metric_filtersarray of objectscan be null

              One option: ProfileRandomSampleCondition
              • typestringrequired

                profile-sample
              • percentageintegerrequired

              One option: ProfileHasCustomObjectCondition
              • typestringrequired

                profile-has-custom-object
              • object_type_idstringrequired

              • object_type_relationship_idstringrequired

              • filterobjectrequired

              • filtersarray of objectsrequired

              One option: ProfilePermissionsCondition
              • typestringrequired

                profile-permissions
              • permissionobjectrequired

              • channelstringrequired

                email_click_trackingemail_open_trackingwhatsapp_marketingwhatsapp_transactional
              One option: ProfileHasNotReceivedEmailMessageCondition
              • typestringrequired

                profile-not-sent-email
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedSmsMessageCondition
              • typestringrequired

                profile-not-sent-sms
              • timeframe_filterobjectrequired

              One option: ProfileHasNotReceivedPushMessageCondition
              • typestringrequired

                profile-not-sent-push
              • timeframe_filterobjectrequired

        • automation_idstringcan be null

        • expiry_hoursintegercan be null

    • relationshipsobject

      relationships: 2 fields
      • flow-actionobject

        flow-action: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            flow-action
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

      • templateobject

        template: 2 fields
        • dataobject

          data: 2 fields
          • typestringrequired

            template
          • idstringrequired

        • linksobject

          links: 2 fields
          • selfstring (uri)required

          • relatedstring (uri)required

    • linksobjectrequired

      links: 1 field
      • selfstring (uri)required

  • linksobject

    links: 1 field
    • selfstring (uri)required

  • metaobject

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject