Skip to content

EmailSegment.md

Latest commit

 

History

History
60 lines (54 loc) · 3.14 KB

EmailSegment.md

File metadata and controls

60 lines (54 loc) · 3.14 KB
Raw

UltracartClient::EmailSegment

Properties

Name Type Description Notes
allow_csv_download Boolean True if the current user has the rights to download this segment. [optional]
allow_facebook_audiences Boolean True if this StoreFront has the Facebook Analytics app connected and supports them [optional]
created_dts String Created date [optional]
deleted Boolean True if this campaign was deleted [optional]
email_segment_uuid String Email segment UUID [optional]
esp_list_segment_folder_uuid String List/Segment folder UUID [optional]
facebook_custom_audience Boolean True if you want to sync to a facebook custom audience [optional]
filter_profile_equation_json String File profile equation json [optional]
member_count Integer Count of members in this segment [optional]
merchant_id String Merchant ID [optional]
name String Name of email segment [optional]
rank_json String Rank settings json [optional]
rebuild_percentage Float Percentage of completion for a rebuild. The value range will be 0-1. Multiply by 100 to format for display. [optional]
rebuild_required Boolean True if a rebuild is required because some part of the segment has changed [optional]
storefront_oid Integer Storefront oid [optional]
thirdparty_join_add_tags Array<String> Third party provider tags to add when a customer joins the segment. [optional]
thirdparty_join_remove_tags Array<String> Third party provider tags to remove when a customer joins the segment. [optional]
thirdparty_leave_add_tags Array<String> Third party provider tags to add when a customer leaves the segment. [optional]
thirdparty_leave_remove_tags Array<String> Third party provider tags to remove when a customer leaves the segment. [optional]
thirdparty_list_id String List id of third party provider to sync with. [optional]
thirdparty_provider_name String Name of third party provider to sync segment to a list with. [optional]
used_by Array<EmailListSegmentUsedBy> Details on the flows or campaigns that use this list. [optional]

Example

require 'ultracart_api'

instance = UltracartClient::EmailSegment.new(
  allow_csv_download: null,
  allow_facebook_audiences: null,
  created_dts: null,
  deleted: null,
  email_segment_uuid: null,
  esp_list_segment_folder_uuid: null,
  facebook_custom_audience: null,
  filter_profile_equation_json: null,
  member_count: null,
  merchant_id: null,
  name: null,
  rank_json: null,
  rebuild_percentage: null,
  rebuild_required: null,
  storefront_oid: null,
  thirdparty_join_add_tags: null,
  thirdparty_join_remove_tags: null,
  thirdparty_leave_add_tags: null,
  thirdparty_leave_remove_tags: null,
  thirdparty_list_id: null,
  thirdparty_provider_name: null,
  used_by: null
)