SceniqDevelopers

AboutCreatorSection

Markdown

The creator's bio, social links and video. Bio and social links come from the creator profile unless this page overrides them. Can be switched off.

Fields

  • 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 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 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.

Used by