SalesPage

Markdown

The default sales page and the photos it may use.

Fields

productIdstring · guide idrequired
The guide's id.
listingobject or nullrequired
The default sales page, or null before a draft exists.
Show 12 fieldsHide fields
- listingIdstring · sales page idrequired
  The sales page's id.
- statusstringrequired
  Whether a version is live.
  publishedunpublished
- baseLanguagestringrequired
  The language of draftConfig.
- draftConfigListingConfigrequired
  The draft: what save_sales_page_draft replaces.
  Show 8 fieldsHide fieldsof ListingConfig
  heroHeroSectionrequired
  The top of the page, always shown.
  Show 6 fieldsHide fieldsof HeroSection
  carouselarray of ListingSliderequired
  Up to 12 slides that turn automatically. Publishing needs at least one.
  Show 3 fieldsHide fieldsof ListingSlide
  mediaIdstring · photo idrequired
  A product- or listing-owned photo of this guide (list_media with marketingOnly true). Spot and chapter photos are refused.
  captionstringoptional
  The caption for this slide. Absent means the photo's own caption.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  titlestringrequired
  The page title, usually the guide's name. Publishing needs one.
  headlinestringoptional
  One line under the title, at most 200 characters. Absent or empty falls back to the guide's headline (update_guide).
  kickerstringoptional
  An eyebrow above the title.
  bulletsarray of objectsrequired
  The selling points: at most 6 on save, 2 to 6 and none empty to publish.
  Show 2 fieldsHide fields
  textstringrequired
  One selling point.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  collectionMediaIdstring · photo idoptional
  An optional collage image, a product- or listing-owned photo of this guide, shown on the buy card beside the page on wide screens.
  pitchPitchSectionrequired
  What's inside: boxes with a title, text and a photo or icon. Can be switched off.
  Show 5 fieldsHide fieldsof PitchSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled section needs at least one box, each with a title.
  titlestringoptional
  The section heading. Absent or empty shows What's inside.
  descriptionstringoptional
  A line under the heading.
  imageAspectstringoptional
  The crop of every box photo: 3:2, 1:1 or 4:5 (the default).
  3:21:14:5
  boxesarray of objectsrequired
  Up to 24 boxes.
  Show 5 fieldsHide fields
  mediaIdstring · photo idoptional
  An optional photo on top of the box, a product- or listing-owned photo of this guide.
  emojistringoptional
  An emoji the creator chose for the box's icon tile, shown when the box has no photo (beside the title when it has one). Agents leave it empty (no emoji in any field); without one the page picks an icon from the title.
  titlestringrequired
  The box title. Publishing needs one on every box.
  descriptionstringoptional
  The box text.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  reviewsReviewsSectionrequired
  Testimonials. Can be switched off.
  Show 4 fieldsHide fieldsof ReviewsSection
  enabledbooleanrequired
  false hides the section and the star rating under the hero title.
  sourcestringrequired
  Where the testimonials come from: custom (the creator's own quotes in custom), platform (testimonials Sceniq curates) or product (labelled Buyer Reviews; the page currently shows the curated platform testimonials for it too).
  productplatformcustom
  headingstringoptional
  The section heading. Absent or empty shows the source's default: What people say (custom), Platform Reviews (platform) or Buyer Reviews (product).
  customarray of CustomReviewoptional
  The creator's testimonials, up to 12, shown when source is custom. Publishing an enabled custom section needs at least one.
  Show 9 fieldsHide fieldsof CustomReview
  namestringrequired
  The reviewer's name. Publishing needs one.
  quotestringrequired
  The quote, word for word. Publishing needs one; quotes over 140 characters collapse behind Read more.
  ratingnumberoptional
  Stars as a whole number from 1 to 5; stars show only when it is set. Never invent one.
  verifiedbooleanoptional
  Ignored: every save removes it, so testimonials the creator enters never show a verified badge.
  platformstringoptional
  instagram, tiktok or youtube. With a handle, the handle links to the profile.
  instagramtiktokyoutube
  handlestringoptional
  The reviewer's handle, shown with a leading @.
  followerCountnumberoptional
  The reviewer's followers as a whole number from 0, shown next to the handle (12K).
  avatarMediaIdstring · photo idoptional
  The reviewer's photo, a product- or listing-owned photo of this guide.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  galleryGallerySectionrequired
  Full-screen photos with captions. Can be switched off; off in a new draft.
  Show 4 fieldsHide fieldsof GallerySection
  enabledbooleanrequired
  false hides the section. Publishing an enabled gallery needs at least one slide.
  titlestringoptional
  The section heading. Absent or empty shows From the field.
  descriptionstringoptional
  A line under the heading.
  slidesarray of ListingSliderequired
  Up to 48 slides.
  Show 3 fieldsHide fieldsof ListingSlide
  mediaIdstring · photo idrequired
  A product- or listing-owned photo of this guide (list_media with marketingOnly true). Spot and chapter photos are refused.
  captionstringoptional
  The caption for this slide. Absent means the photo's own caption.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  aboutCreatorAboutCreatorSectionrequired
  The creator's bio, social links and video, with per-page overrides. Can be switched off.
  Show 4 fieldsHide fieldsof AboutCreatorSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled section needs a bio, social links or a video.
  descriptionOverridestringoptional
  The about text for this page only. Absent means the creator's profile bio.
  socialsOverridearray of SocialLinkoptional
  Social links for this page only; [] shows none. Absent means the profile's social links.
  Show 4 fieldsHide fieldsof SocialLink
  platformstringrequired
  instagram, tiktok or youtube.
  instagramtiktokyoutube
  handlestringrequired
  The account name (@name). Required on the profile; the link pill shows it when there is no follower count.
  urlstringrequired
  The profile page (https; set_profile_socials refuses other links). An empty url on a sales page falls back to the link built from platform and handle.
  followerCountnumberoptional
  Followers as the creator states them, a whole number from 0, shown on the pill (12K) instead of the handle.
  videoIntroVideooptional
  A video for the section. Absent shows no video.
  Show 6 fieldsHide fieldsof IntroVideo
  providerstringrequired
  youtube, vimeo or upload (a video file stored on Sceniq).
  youtubevimeoupload
  youtubeIdstringoptional
  For youtube: the video id (the v= value of a watch link), never a URL or an embed code.
  vimeoIdstringoptional
  For vimeo: the numeric id from the video's link. The player loads only after a click.
  storageIdstring · stored file idoptional
  For upload: the stored video file. The API cannot upload videos; keep the value you read.
  fileUrlstringoptional
  For upload: a direct link to the video file, used when there is no storageId.
  captionstringoptional
  A line under the video.
  buyFormBuyFormSectionrequired
  The buy section with the checkout, always shown.
  Show 3 fieldsHide fieldsof BuyFormSection
  ctaLabelstringoptional
  The label of every buy button on the page, at most 60 characters. Absent or empty falls back to the guide's purchaseButtonText, then Get the guide.
  reassuranceTextstringoptional
  A short line over the bottom of the checkout photo, or above the checkout without one.
  imageMediaIdstring · photo idoptional
  A photo above the checkout in a 3:2 crop, a product- or listing-owned photo of this guide.
  faqFaqSectionoptional
  Questions and answers below the buy form. Can be switched off; off in a new draft. Absent on drafts saved before the section existed.
  Show 3 fieldsHide fieldsof FaqSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled FAQ needs at least one item, each with a question and an answer.
  titlestringoptional
  The section heading. Absent or empty shows Common questions.
  itemsarray of objectsrequired
  Up to 12 items.
  Show 3 fieldsHide fields
  questionstringrequired
  The question.
  answerstringrequired
  The answer.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  sectionOrderarray of stringsoptional
  The page order of the sections below the hero: pitch, reviews, gallery, aboutCreator, buyForm and faq, each at most once. Missing sections follow in that default order; absent means the default.
  pitchreviewsgalleryaboutCreatorbuyFormfaq
- draftUpdatedAtnumberrequired
  When the draft last changed.
- publishedConfigListingConfig or nullrequired
  What buyers see.
  Show 8 fieldsHide fieldsof ListingConfig
  heroHeroSectionrequired
  The top of the page, always shown.
  Show 6 fieldsHide fieldsof HeroSection
  carouselarray of ListingSliderequired
  Up to 12 slides that turn automatically. Publishing needs at least one.
  Show 3 fieldsHide fieldsof ListingSlide
  mediaIdstring · photo idrequired
  A product- or listing-owned photo of this guide (list_media with marketingOnly true). Spot and chapter photos are refused.
  captionstringoptional
  The caption for this slide. Absent means the photo's own caption.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  titlestringrequired
  The page title, usually the guide's name. Publishing needs one.
  headlinestringoptional
  One line under the title, at most 200 characters. Absent or empty falls back to the guide's headline (update_guide).
  kickerstringoptional
  An eyebrow above the title.
  bulletsarray of objectsrequired
  The selling points: at most 6 on save, 2 to 6 and none empty to publish.
  Show 2 fieldsHide fields
  textstringrequired
  One selling point.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  collectionMediaIdstring · photo idoptional
  An optional collage image, a product- or listing-owned photo of this guide, shown on the buy card beside the page on wide screens.
  pitchPitchSectionrequired
  What's inside: boxes with a title, text and a photo or icon. Can be switched off.
  Show 5 fieldsHide fieldsof PitchSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled section needs at least one box, each with a title.
  titlestringoptional
  The section heading. Absent or empty shows What's inside.
  descriptionstringoptional
  A line under the heading.
  imageAspectstringoptional
  The crop of every box photo: 3:2, 1:1 or 4:5 (the default).
  3:21:14:5
  boxesarray of objectsrequired
  Up to 24 boxes.
  Show 5 fieldsHide fields
  mediaIdstring · photo idoptional
  An optional photo on top of the box, a product- or listing-owned photo of this guide.
  emojistringoptional
  An emoji the creator chose for the box's icon tile, shown when the box has no photo (beside the title when it has one). Agents leave it empty (no emoji in any field); without one the page picks an icon from the title.
  titlestringrequired
  The box title. Publishing needs one on every box.
  descriptionstringoptional
  The box text.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  reviewsReviewsSectionrequired
  Testimonials. Can be switched off.
  Show 4 fieldsHide fieldsof ReviewsSection
  enabledbooleanrequired
  false hides the section and the star rating under the hero title.
  sourcestringrequired
  Where the testimonials come from: custom (the creator's own quotes in custom), platform (testimonials Sceniq curates) or product (labelled Buyer Reviews; the page currently shows the curated platform testimonials for it too).
  productplatformcustom
  headingstringoptional
  The section heading. Absent or empty shows the source's default: What people say (custom), Platform Reviews (platform) or Buyer Reviews (product).
  customarray of CustomReviewoptional
  The creator's testimonials, up to 12, shown when source is custom. Publishing an enabled custom section needs at least one.
  Show 9 fieldsHide fieldsof CustomReview
  namestringrequired
  The reviewer's name. Publishing needs one.
  quotestringrequired
  The quote, word for word. Publishing needs one; quotes over 140 characters collapse behind Read more.
  ratingnumberoptional
  Stars as a whole number from 1 to 5; stars show only when it is set. Never invent one.
  verifiedbooleanoptional
  Ignored: every save removes it, so testimonials the creator enters never show a verified badge.
  platformstringoptional
  instagram, tiktok or youtube. With a handle, the handle links to the profile.
  instagramtiktokyoutube
  handlestringoptional
  The reviewer's handle, shown with a leading @.
  followerCountnumberoptional
  The reviewer's followers as a whole number from 0, shown next to the handle (12K).
  avatarMediaIdstring · photo idoptional
  The reviewer's photo, a product- or listing-owned photo of this guide.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  galleryGallerySectionrequired
  Full-screen photos with captions. Can be switched off; off in a new draft.
  Show 4 fieldsHide fieldsof GallerySection
  enabledbooleanrequired
  false hides the section. Publishing an enabled gallery needs at least one slide.
  titlestringoptional
  The section heading. Absent or empty shows From the field.
  descriptionstringoptional
  A line under the heading.
  slidesarray of ListingSliderequired
  Up to 48 slides.
  Show 3 fieldsHide fieldsof ListingSlide
  mediaIdstring · photo idrequired
  A product- or listing-owned photo of this guide (list_media with marketingOnly true). Spot and chapter photos are refused.
  captionstringoptional
  The caption for this slide. Absent means the photo's own caption.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  aboutCreatorAboutCreatorSectionrequired
  The creator's bio, social links and video, with per-page overrides. Can be switched off.
  Show 4 fieldsHide fieldsof AboutCreatorSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled section needs a bio, social links or a video.
  descriptionOverridestringoptional
  The about text for this page only. Absent means the creator's profile bio.
  socialsOverridearray of SocialLinkoptional
  Social links for this page only; [] shows none. Absent means the profile's social links.
  Show 4 fieldsHide fieldsof SocialLink
  platformstringrequired
  instagram, tiktok or youtube.
  instagramtiktokyoutube
  handlestringrequired
  The account name (@name). Required on the profile; the link pill shows it when there is no follower count.
  urlstringrequired
  The profile page (https; set_profile_socials refuses other links). An empty url on a sales page falls back to the link built from platform and handle.
  followerCountnumberoptional
  Followers as the creator states them, a whole number from 0, shown on the pill (12K) instead of the handle.
  videoIntroVideooptional
  A video for the section. Absent shows no video.
  Show 6 fieldsHide fieldsof IntroVideo
  providerstringrequired
  youtube, vimeo or upload (a video file stored on Sceniq).
  youtubevimeoupload
  youtubeIdstringoptional
  For youtube: the video id (the v= value of a watch link), never a URL or an embed code.
  vimeoIdstringoptional
  For vimeo: the numeric id from the video's link. The player loads only after a click.
  storageIdstring · stored file idoptional
  For upload: the stored video file. The API cannot upload videos; keep the value you read.
  fileUrlstringoptional
  For upload: a direct link to the video file, used when there is no storageId.
  captionstringoptional
  A line under the video.
  buyFormBuyFormSectionrequired
  The buy section with the checkout, always shown.
  Show 3 fieldsHide fieldsof BuyFormSection
  ctaLabelstringoptional
  The label of every buy button on the page, at most 60 characters. Absent or empty falls back to the guide's purchaseButtonText, then Get the guide.
  reassuranceTextstringoptional
  A short line over the bottom of the checkout photo, or above the checkout without one.
  imageMediaIdstring · photo idoptional
  A photo above the checkout in a 3:2 crop, a product- or listing-owned photo of this guide.
  faqFaqSectionoptional
  Questions and answers below the buy form. Can be switched off; off in a new draft. Absent on drafts saved before the section existed.
  Show 3 fieldsHide fieldsof FaqSection
  enabledbooleanrequired
  false hides the section. Publishing an enabled FAQ needs at least one item, each with a question and an answer.
  titlestringoptional
  The section heading. Absent or empty shows Common questions.
  itemsarray of objectsrequired
  Up to 12 items.
  Show 3 fieldsHide fields
  questionstringrequired
  The question.
  answerstringrequired
  The answer.
  ordernumberrequired
  Sort key, ascending; fractional values are fine.
  sectionOrderarray of stringsoptional
  The page order of the sections below the hero: pitch, reviews, gallery, aboutCreator, buyForm and faq, each at most once. Missing sections follow in that default order; absent means the default.
  pitchreviewsgalleryaboutCreatorbuyFormfaq
- publishedAtnumber or nullrequired
  When it was last published.
- publishedConfigVersionnumberrequired
  The live version's number.
- localesarray of stringsrequired
  Published translations as language codes, besides baseLanguage ([] for a page in one language).
- metaTitlestring or nullrequired
  The search result title.
- metaDescriptionstring or nullrequired
  The search result description.
- updatedAtnumberrequired
  When the row last changed (Unix time in milliseconds).
mediaMapmap of objectsrequired
The photos the sales page may use, keyed by mediaId.
Show 7 fieldsHide fields
- idstring · photo idrequired
  The photo's id.
- urlstringrequired
  The photo's URL.
- captionstringoptional
  Caption.
- creditstringoptional
  Photographer credit.
- widthnumberoptional
  Width in pixels.
- heightnumberoptional
  Height in pixels.
- ordernumberrequired
  Position.
publishingstringrequired
Who publishes the sales page (the creator, in the studio).

Used by

get_sales_page