Skip to content

Flows API

List an action's messages

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

Sort by created, id, name, updated, ascending or descending (put - in front).

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_messages The same operation as in Klaviyo's API. OpenAPI document

Path parameters

stringrequired

Query parameters

array of strings

Attributes of flow-message resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

string

Filter expression.

Filtering guide

Fields and the operators each one takes:

  • id: any
  • name: contains, ends-with, equals, starts-with
  • created: equals, greater-or-equal, greater-than, less-or-equal, less-than
  • updated: equals, greater-or-equal, greater-than, less-or-equal, less-than

string

From links.next or links.prev of the previous page.

Pagination guide

integer1 to 50default 50

Default 50, at most 50.

Pagination guide

string

Default id.

Sorting guide

Headers

stringrequireddefault 2026-10-15

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

Revisions guide

Responses

200Success

Response body

object

  • dataarray of objectsrequired

    data: 5 fields
    • 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: 3 fields
    • selfstring (uri)required

    • prevstring (uri)

    • nextstring (uri)

  • 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