ApiV2
| API | Description |
|---|
CheckIn
| API | Description |
|---|
LogApi
| API | Description |
|---|
BookingBlock
| API | Description |
|---|---|
| PUT api/booking-blocks/{blockId} |
Updates a booking block's core information, such as view and layout settings. |
| PUT api/booking-blocks/{blockId}/design |
Updates the visual layout (Grid vs List) and orientation preferences for the booking block. |
| POST api/booking-blocks/{blockId}/items |
Creates a new bookable item (like a property or service) and attaches it to the block. |
| PUT api/booking-blocks/{blockId}/items/{itemId} |
Updates the details (price, description, capacity) and status of an existing booking item. |
| GET api/booking-blocks/{blockId}/items/{itemId} |
Retrieves complete information for a specific booking item, including its availability calendar. |
| PUT api/booking-blocks/{blockId}/items/sort |
Updates the manual display order of items within a booking block. |
| DELETE api/booking-blocks/{blockId}/items/{itemId} |
Removes a booking item and its historical/future availability data from the block. |
| GET api/booking-blocks/{blockId}/items/{itemId}/availability?dateFrom={dateFrom}&dateTo={dateTo} |
Fetches availability and price exceptions for an item over a given date range. |
| POST api/booking-blocks/{blockId}/items/{itemId}/availability |
Manually sets whether an item is available and what its price is for a specific calendar date. |
| POST api/booking-blocks/{blockId}/items/{itemId}/availability/bulk |
Updates availability and pricing for a range of dates in a single bulk operation. |
| POST api/booking-blocks/{blockId}/items/{itemId}/check-availability |
Performs a validation check to see if an item can be booked for a specific range and calculates total cost. |
| POST api/booking-blocks/{blockId}/orders |
Submits a reservation request for an item, verifying availability and locking in the calculated price. |
| GET api/booking-blocks/{blockId}/orders |
Returns all reservation orders assigned to the specific booking block (privileged owner view). |
| GET api/booking-blocks/{blockId}/orders/{orderId} |
Retrieves detailed information for a single specific booking order. |
| PUT api/booking-blocks/{blockId}/orders/{orderId}/status |
Updates the fulfilment status of a booking (e.g., from 'pending' to 'confirmed' or 'cancelled'). |
| DELETE api/booking-blocks/{blockId}/orders/{orderId} |
Deletes a booking order |
| GET api/my-bookings |
Retrieves all bookings ever made by the currently authenticated user across all blocks. |
MembershipBlock
| API | Description |
|---|---|
| PUT api/membership-blocks/{blockId} |
Updates the content and settings of a membership block. |
| PUT api/membership-blocks/{blockId}/design |
Updates the design settings of a membership block. |
| POST api/profiles/{profileId}/memberships |
Adds a new membership tier to a profile. |
| PUT api/profiles/{profileId}/memberships/{id} |
Updates an existing membership tier within a profile. |
| GET api/profiles/{profileId}/memberships/{id} |
Retrieves a specific membership tier within a profile. |
| GET api/membership-blocks/{blockId}/tiers |
Retrieves all membership tiers within a specific membership block. |
| DELETE api/profiles/{profileId}/memberships/{id} |
Deletes a membership tier from a profile. |
| PUT api/profiles/{profileId}/memberships/{id}/checkout/fields |
Updates the checkout fields for a membership tier. |
| POST api/profiles/{profileId}/memberships/{id}/submit |
Submits a membership order for a specific membership tier. |
Device
| API | Description |
|---|
ProductRequest
| API | Description |
|---|
TelegramAiBot
| API | Description |
|---|
MarketplaceListing
| API | Description |
|---|
PollBlock
| API | Description |
|---|
LayoutTemplate
| API | Description |
|---|
CartAbandonment
| API | Description |
|---|
LinkLockOrder
| API | Description |
|---|
UserAgentWorkstream
| API | Description |
|---|
Assistant
| API | Description |
|---|
SmartRouting
| API | Description |
|---|
NotificationTest
| API | Description |
|---|
BlockSuggestion
| API | Description |
|---|
Track
| API | Description |
|---|
TimetableBlock
| API | Description |
|---|---|
| PUT api/timetable-blocks/{blockId} |
Updates an existing timetable block with new content settings. |
| PUT api/timetable-blocks/{blockId}/design |
Updates the design settings of a timetable block. |
| POST api/timetable-blocks/{blockId}/items |
Adds a new timetable item to a timetable block. |
| PUT api/timetable-blocks/{blockId}/items/{itemId} |
Updates an existing timetable item with new information. |
| PUT api/timetable-blocks/{blockId}/items/sort |
Updates the display order of timetable items within a timetable block. |
| DELETE api/timetable-blocks/{blockId}/items/{itemId} |
Deletes a timetable item from a timetable block. |
DonationBlock
| API | Description |
|---|---|
| PUT api/donation-blocks/{blockId} |
Updates the core header information (title, description, and image) for a donation block. |
| PUT api/donation-blocks/{blockId}/design |
Updates the visual layout and theme colors for the donation block. |
| POST api/profiles/{profileId}/donations/quick |
Quickly adds a predefined donation type (Donation, Tip, Monobank, Privat24) to the profile. |
| POST api/profiles/{profileId}/donations |
Creates a standard new donation item for a profile. |
| PUT api/profiles/{profileId}/donations/{id}/settings |
Toggles display options for the donation form (comments, name, phone). |
| PUT api/profiles/{profileId}/donations/{id} |
Updates an existing donation's metadata, targets, financial goals, and SEO parameters. |
| GET api/profiles/{profileId}/donations/{id} |
Retrieves detailed information for a single specific donation item. |
| PUT api/donation-blocks/{blockId}/items/sort |
Updates the manual display order of donation items within the block. |
| DELETE api/profiles/{profileId}/donations/{id} |
Permanently removes a donation item from the profile. |
| POST api/profiles/{profileId}/donations/{id}/amounts |
Adds a predefined donation amount option (e.g., $10, $50) for the donation item. |
| PUT api/profiles/{profileId}/donations/{id}/amounts/{amountId} |
Updates the value of a predefined donation amount. |
| PUT api/profiles/{profileId}/donations/{id}/amounts/sort |
Updates the manual display order of predefined donation amounts. |
| DELETE api/profiles/{profileId}/donations/{id}/amounts/{amountId} |
Removes a predefined donation amount option permanently. |
| PUT api/profiles/{profileId}/donations/{itemId}/checkout/fields |
Configures which customer data fields (identity, contact) are required during the donation process. |
| POST api/profiles/{profileId}/donations/checkout-session?id={id} |
Generates a Stripe checkout session for a specific donation order. |
| POST api/profiles/{profileId}/donations/{id}/submit |
Finalizes a donation submission with customer information and chosen amount. |
YoutubeToText
| API | Description |
|---|
Marketplace
| API | Description |
|---|
LinkBlock
| API | Description |
|---|---|
| PUT api/link-blocks/{blockId}/design |
Updates the visual display mode of the link block (e.g., classic, grid, slider). |
| PUT api/link-blocks/{blockId}/design/item?type={type} |
Updates the design settings for all items within a link block (colors, borders, shapes). |
| PUT api/link-blocks/{blockId}/items/{id}/lock |
Configures access restrictions for a specific link (password, age limit, or payment). |
| POST api/link-blocks/{blockId}/items/{id}/verify |
Verifies credentials (password or birthdate) to unlock a restricted link. |
| PUT api/link-blocks/{blockId}/items/{id}/schedule |
Schedules when a link should be visible or hidden based on specific time intervals. |
| PUT api/link-blocks/{blockId}/items/{id}/countdown |
Displays a countdown timer for a link until a specific date or event occurs. |
| PUT api/link-blocks/{blockId}/items/{id}/animation |
Applies an eye-catching animation (bounce, jello, fade) to a link. |
| GET api/link-blocks/{blockId}/items/{id}/download |
Initiates a file download for a link item that points to a document or asset. |
| POST api/link-blocks/{blockId}/items/quick |
Simplified creation of a link by providing only its URL and type (e.g., manual addition). |
| POST api/link-blocks/{blockId}/items/{itemId}/labels |
Attaches a predefined label (e.g., 'NEW', 'SALE') to a specific link. |
| DELETE api/link-blocks/{blockId}/items/{itemId}/labels/{labelId} |
Detaches a label from a specific link. |
| POST api/link-blocks/{blockId}/items |
Creates a new link with comprehensive settings (design, locks, tags). |
| PUT api/link-blocks/{blockId}/items/{id} |
Updates an existing link's core data, design, and functional settings. |
| GET api/link-blocks/{blockId}/items/{id} |
Returns detailed metadata and styling information for a specific link. |
| PUT api/link-blocks/{blockId}/items/{itemId}/sublinks |
Links multiple children to a parent link (creating a folder/group structure). |
| DELETE api/link-blocks/{blockId}/items/{itemId}/sublinks/{sublinkId} |
Removes a child link from its parent group. |
| PUT api/link-blocks/{blockId}/items/{id}/quick |
Provides a fast update for basic link metadata (Title, Description, Image). |
| PUT api/link-blocks/{blockId}/items/{id}/active |
Toggles the active/visible state of a specific link. |
| PUT api/link-blocks/{blockId}/items/sort |
Updates the vertical sorting order of links within the block. |
| PUT api/link-blocks/{blockId}/items/{id}/sort |
Sorts sublinks within a parent link. |
| DELETE api/link-blocks/{blockId}/items/{id} |
Permanently removes a link from the block. |
| POST api/profiles/{profileId}/links/{itemId}/automation |
Configures automated Instagram DM replies triggered by specific comments or keywords. |
| PUT api/profiles/{profileId}/links/{itemId}/automation/{id} |
Updates settings, triggers, and response messages for an existing Instagram DM automation. |
| PUT api/profiles/{profileId}/links/{itemId}/automation/{id}/active |
Toggles the active/running status of a specific Instagram automation rule. |
| DELETE api/profiles/{profileId}/links/{itemId}/automation/{id} |
Permanently deletes an Instagram automation rule. |
OverviewBlock
| API | Description |
|---|---|
| POST api/overview-blocks/{blockId}/items |
Adds a new item to an Overview block. |
| PUT api/overview-blocks/{blockId}/items/{id} |
Updates an existing item in an Overview block. |
| DELETE api/overview-blocks/{blockId}/items/{id} |
Deletes an existing item from an Overview block. |
| GET api/overview-blocks/{blockId}/items |
Retrieves all items from an Overview block. |
| PUT api/overview-blocks/{blockId}/items/sort |
Updates the sort order of items in an Overview block. |
DiscountBlock
| API | Description |
|---|
Audience
| API | Description |
|---|---|
| GET api/profiles/{profileId}/audience/members?optIn={optIn}&search={search}&take={take}&skip={skip} |
Retrieves a list of audience members for a given profile. |
| GET api/profiles/{profileId}/audience/members/count |
Retrieves the count of audience members, form responses, subscribers, and customers for a given profile. |
| POST api/profiles/{profileId}/audience/members |
Adds a new audience member to a profile manually. |
| DELETE api/profiles/{profileId}/audience/members/{id} |
Deletes an audience member from a profile. |
| DELETE api/profiles/{profileId}/audience/members |
Deletes all audience members associated with a profile. |
| GET api/profiles/{profileId}/audience/subscribers?take={take}&skip={skip} |
Retrieves a list of subscribers for a given profile. |
| DELETE api/profiles/{profileId}/audience/subscribers/{id} |
Deletes a specific subscriber from a profile. |
| DELETE api/profiles/{profileId}/audience/subscribers |
Deletes all subscribers associated with a profile. |
| GET api/profiles/{profileId}/audience/forms?take={take}&skip={skip} |
Retrieves form responses for a given profile. |
| DELETE api/profiles/{profileId}/audience/forms/{id} |
Deletes a specific form response from a profile. |
| DELETE api/profiles/{profileId}/audience/forms |
Deletes all form responses associated with a profile. |
| GET api/profiles/{profileId}/audience/customers?take={take}&skip={skip} |
Retrieves a list of customers who have purchased products from a given profile. |
ProductDelivery
| API | Description |
|---|
HighlightBlock
| API | Description |
|---|---|
| PUT api/highlight-blocks/{blockId} |
Updates the heading settings of a highlight block. |
| PUT api/highlight-blocks/{blockId}/design |
Updates the design configuration of a highlight block including view and layout settings. |
| POST api/highlight-blocks/{blockId}/items |
Adds a new highlight item to the specified highlight block. |
| PUT api/highlight-blocks/{blockId}/items/{id} |
Updates an existing highlight item within the specified highlight block. |
| PUT api/highlight-blocks/{blockId}/items/sort |
Reorders highlight items within a block by updating their position indices. |
| DELETE api/highlight-blocks/{blockId}/items/{id} |
Permanently deletes a highlight item from the specified highlight block. |
WallBlock
| API | Description |
|---|
TelegramNotification
| API | Description |
|---|---|
| GET api/telegram/chat?id={id} |
Retrieves a Telegram chat associated with a specific profile. This allows fetching stored Telegram chat details linked to a user profile. |
| DELETE api/telegram/disconnect |
Disconnects a Telegram chat from a user profile. This removes the associated Telegram chat and any related notification settings. |
DeveloperApp
| API | Description |
|---|
ContentTemplate
| API | Description |
|---|
FormBlock
| API | Description |
|---|---|
| PUT api/form-blocks/{blockId} |
Updates the configuration of form fields, requirements, and basic heading details. |
| PUT api/form-blocks/{blockId}/design |
Updates the visual style and display view of the form block. |
| POST api/form-blocks/{blockId}/items |
Adds a new custom field (text, dropdown, radio, etc.) to the form block. |
| PUT api/form-blocks/{blockId}/items/{id} |
Updates an existing custom form field's label, type, or options. |
| DELETE api/form-blocks/{blockId}/items/{id} |
Permanently deletes a custom field from the form block. |
| PUT api/form-blocks/{blockId}/settings/result |
Updates the post-submission actions (redirect, message, downloads). |
| POST api/form-blocks/{blockId}/submit |
Processes a user's form submission, saves the response, and triggers post-submission workflows. |
AiVideoWorker
| API | Description |
|---|
PublicBlogApi
| API | Description |
|---|
LinkedInAds
| API | Description |
|---|
TipConfig
| API | Description |
|---|
Subscription
| API | Description |
|---|---|
| GET api/subscriptions/by-number/{number} |
Retrieves subscription details based on the provided subscription number. If the provided number matches an order number instead of a subscription number, an appropriate error message is returned. |
LinkShortener
| API | Description |
|---|---|
| POST api/profiles/{profileId}/short-links/share |
Creates a short link for sharing content from a specified profile, supporting different target types such as redirect, highlight, or standalone pages. |
| PUT api/profiles/{profileId}/short-links/{id}/share/target |
Updates the target type and destination of a short link, allowing changes between redirect, highlight, or standalone pages. |
| PUT api/profiles/{profileId}/short-links/{id}/slug |
Customizes the short link URL by updating its unique slug. |
| POST api/profiles/{profileId}/short-links |
Creates a new short link with custom metadata and UTM parameters for a specified profile. |
| POST api/short-links |
Creates an anonymous short link without profile association, primarily used for public shortening services. |
| PUT api/profiles/{profileId}/short-links/{id} |
Updates an existing short link's metadata, destination parameters, and active status. |
| PUT api/profiles/{profileId}/short-links/{id}/name |
Updates only the friendly display name of a specific short link. |
| PUT api/profiles/{profileId}/short-links/{id}/destination |
Updates the target destination URL of a specific short link. |
| PUT api/profiles/{profileId}/short-links/{id}/active |
Toggles the active status of a short link, effectively enabling or disabling the redirect. |
| GET api/profiles/{profileId}/short-links/{id} |
Retrieves the configuration and metadata for a specific short link by its primary identifier. |
| GET api/profiles/{profileId}/short-links/{code}/code |
Retrieves the details of a short link using its unique URL code or slug. |
| DELETE api/profiles/{profileId}/short-links/{id} |
Permanently deletes a short link and its associated tracking data. |
BlockMeta
| API | Description |
|---|
MotionVideo
| API | Description |
|---|
MotionWorker
| API | Description |
|---|
Zoom
| API | Description |
|---|
ProfileClone
| API | Description |
|---|
ReviewBlock
| API | Description |
|---|---|
| PUT api/review-blocks/{blockId} |
Updates a review block with new heading details. |
| PUT api/review-blocks/{blockId}/design |
Updates the design layout of a review block. |
| PUT api/review-blocks/{blockId}/items/sort |
Sorts the review items within a specific review block. |
| POST api/review-blocks/{blockId}/items |
Adds a new review item to a specific review block. |
| PUT api/review-blocks/{blockId}/items/{id} |
Updates an existing review item in a specific review block. |
| DELETE api/review-blocks/{blockId}/items/{id} |
Deletes a review item from a review block. |
DeveloperApiKeys
| API | Description |
|---|
AppDraft
| API | Description |
|---|
AiChatWidget
| API | Description |
|---|
BlockElement
| API | Description |
|---|
PaymentProviders
| API | Description |
|---|
Sitemap
| API | Description |
|---|---|
| GET api/domains/{domain}/robots |
Generates a dynamic robots.txt file for a specific custom domain. |
InstagramDesign
| API | Description |
|---|
Tab
| API | Description |
|---|---|
| POST api/profiles/{profileId}/tabs |
Adds a new tab to a profile. |
| PUT api/profiles/{profileId}/tabs/{tabId} |
Updates an existing tab in a profile. |
| PUT api/profiles/{profileId}/tabs/{tabId}/rename |
Renames a specific tab in a profile. |
| DELETE api/profiles/{profileId}/tabs/{tabId} |
Deletes a tab from a profile. |
| PUT api/profiles/{profileId}/design/tabs2 |
Updates the tab navigation settings and items for a profile with enhanced functionality. This version allows for more detailed tab configuration than the original UpdateTabNavigation. |
| PUT api/profiles/{profileId}/design/tabs |
Updates the basic tab navigation settings for a profile. |
| PUT api/profiles/{profileId}/design/tabs/status |
Updates only the active status of profile tabs without changing other properties. |
| PUT api/profiles/{profileId}/design/tabs/sort |
Updates the display order of tabs in the profile navigation. |
ContentSearch
| API | Description |
|---|
TemplateMarketplace
| API | Description |
|---|
TimelineBlock
| API | Description |
|---|---|
| PUT api/timeline-blocks/{blockId} |
Updates an existing timeline block with new content settings. |
| PUT api/timeline-blocks/{blockId}/design |
Updates the design settings of a timeline block. |
| POST api/timeline-blocks/{blockId}/items |
Adds a new timeline item to a timeline block. |
| PUT api/timeline-blocks/{blockId}/items/{itemId} |
Updates an existing timeline item with new information. |
| PUT api/timeline-blocks/{blockId}/items/sort |
Updates the display order of timeline items within a timeline block. |
| DELETE api/timeline-blocks/{blockId}/items/{itemId} |
Deletes a timeline item from a timeline block. |
PlanEntitlement
| API | Description |
|---|
EmailCampaign
| API | Description |
|---|
Webhooks
| API | Description |
|---|
AiChatWidgetPublic
| API | Description |
|---|
GoogleAds
| API | Description |
|---|
ChatAi
| API | Description |
|---|
CourseEnrollment
| API | Description |
|---|
RecipeBlock
| API | Description |
|---|
StoriesWidget
| API | Description |
|---|
Bluesky
| API | Description |
|---|
Comments
| API | Description |
|---|
Slack
| API | Description |
|---|
UserAgentStore
| API | Description |
|---|
QrCodeManager
| API | Description |
|---|---|
| GET api/qrcode/download/zip?data={data} |
Generates a QR code in both SVG and PNG formats, bundles them into a ZIP archive, and serves it as a downloadable file. |
| GET api/qrcode/download/svg?data={data} |
Generates a QR code in SVG (Scalable Vector Graphics) format and serves it as a downloadable file. |
| GET api/qrcode/download/png?data={data} |
Generates a QR code in PNG format and serves it as a downloadable file. |
CampaignPosts
| API | Description |
|---|
EmailSequence
| API | Description |
|---|
BlogBlock
| API | Description |
|---|---|
| PUT api/blog-blocks/{blockId} |
Updates the general content and settings of a blog block. |
SmartReply
| API | Description |
|---|---|
| GET api/profiles/{profileId}/smart-replies |
Retrieves smart reply automation settings for a specific user profile. This endpoint fetches Instagram DM automation settings linked to the given profile. |
TelegramBots
| API | Description |
|---|---|
| GET api/profiles/{profileId}/telegram/bots |
Retrieves a list of Telegram bots connected to a specific user profile. This endpoint fetches bot accounts associated with the profile and updates their follower count from Telegram. |
| POST api/profiles/{profileId}/telegram/bots |
Adds a new Telegram bot to a specific user profile. This endpoint registers a bot by retrieving its information from Telegram and assigning a webhook based on its purpose. |
| DELETE api/profiles/{profileId}/telegram/bots/{id} |
Deletes a Telegram bot from a specific user profile. This endpoint removes the bot's record from the database and deletes its associated webhook from Telegram. |
| POST api/profiles/{profileId}/telegram/bot |
Adds a new Telegram bot to a specified user profile (legacy/alternative endpoint). This endpoint registers the bot in the system and configures a webhook for incoming messages. |
GoogleMerchant
| API | Description |
|---|
TwitchWebhook
| API | Description |
|---|
VideoBlock
| API | Description |
|---|---|
| PUT api/video-blocks/{blockId} |
Updates a Video block with new content and settings. |
| PUT api/video-blocks/{blockId}/design |
Updates the display settings of a Video block. |
| POST api/video-blocks/{blockId}/item |
Adds a new Video item to a Video block. |
| PUT api/video-blocks/{blockId}/item/{itemId} |
Updates an existing Video item. |
| PUT api/video-blocks/{blockId}/item/sort |
Sorts Video item items within a Video block. |
| DELETE api/video-blocks/{blockId}/item/{itemId} |
Deletes a Video item from a Video block. |
Post
| API | Description |
|---|---|
| PUT api/profiles/{profileId}/posts/tab |
Updates the activation status of the "Posts" tab within a profile's design. |
| PUT api/profiles/{profileId}/posts/last |
Updates whether the most recent posts are displayed as a preview on the profile. |
| PUT api/profiles/{profileId}/posts/design |
Updates the visual design of posts for a profile, including colors and background opacity. |
| POST api/profiles/{profileId}/posts |
Creates a new post for a specific profile, including optional media attachments and privacy settings. |
| GET api/profiles/{username}/posts/{slug}/slug |
Retrieves the detailed configuration and localized metadata for a specific post by its URL slug. |
| GET api/profiles/{profileId}/posts/{id} |
Retrieves the basic entity of a specific post by its ID for a given profile. |
| PUT api/profiles/{profileId}/posts/{id} |
Updates an existing post's content, privacy, layout, and associated media items. |
| GET api/posts?skip={skip}&take={take} |
(Internal/Admin) Retrieves a paginated list of all posts across the entire platform. |
| POST api/posts |
(Public Submission) Creates a new post for a profile without explicit user ID context, primarily for external integrations. |
| GET api/profiles/{profileId}/posts |
Retrieves all posts created within a specific profile. |
| DELETE api/profiles/{profileId}/posts/{id} |
Permanently removes a post from a profile. |
| POST api/profiles/{profileId}/posts/memberships |
Registers a new membership tier (subscription level) used to restrict access to certain posts. |
| PUT api/profiles/{profileId}/posts/memberships/{id} |
Updates the comprehensive settings of a membership tier, including pricing, access limits, and checkout flows. |
| PUT api/profiles/{profileId}/posts/memberships/sort |
Reorders membership tiers within a profile based on a provided sort list. |
| DELETE api/profiles/{profileId}/posts/memberships/{id} |
Permanently removes a membership tier from a profile. |
UserAgentReminder
| API | Description |
|---|
RentalBlock
| API | Description |
|---|---|
| PUT api/rental-blocks/{blockId} |
Updates the heading (title, description, image) of a rental block. |
| POST api/rental-items/{blockId} |
Adds a new rental item to the specified rental block. |
| POST api/rental-blocks/{blockId}/items |
Adds a new rental item to the specified rental block. |
| GET api/rental-blocks/{blockId}/items/{itemId} |
Retrieves a specific rental item with extended information. |
| PUT api/rental-blocks/{blockId}/items/{itemId} |
Updates an existing rental item with new information. |
| DELETE api/rental-blocks/{blockId}/items/{itemId} |
Deletes a rental item from the block. |
AudioInboxBlock
| API | Description |
|---|
StatBlock
| API | Description |
|---|---|
| PUT api/stat-blocks/{blockId} |
Updates an existing stat block with new data. |
| PUT api/stat-blocks/{blockId}/design |
Updates the design settings of a stat block. |
| POST api/stat-blocks/{blockId}/items |
Adds a new stat item to a stat block. |
| PUT api/stat-blocks/{blockId}/items/{id} |
Updates an existing stat item. |
| PUT api/stat-blocks/{blockId}/items/sort |
Sorts stat items within a block. |
| DELETE api/stat-blocks/{blockId}/items/{id} |
Deletes a stat item. |
SplashBlock
| API | Description |
|---|---|
| PUT api/splash-blocks/{blockId} |
Updates the splash screen block settings for a given profile. |
SocialPlanner
| API | Description |
|---|---|
| GET api/profiles/{profileId}/social-planner/accounts |
Retrieves the connected social media accounts for a given profile in the Social Planner. This function fetches all linked social media accounts across various platforms. |
| POST api/profiles/{profileId}/social-planner/tiktok/connect |
Connects a TikTok account to the Social Planner for a specific profile. This function retrieves TikTok user details and stores the account information in the system. |
| DELETE api/profiles/{profileId}/social-planner/accounts/{id}/{type} |
Disconnects a social media account from the Social Planner for a specific profile. This function removes the linked account and its associated data from the system. |
Wheel
| API | Description |
|---|
Community
| API | Description |
|---|
AppointmentCalendar
| API | Description |
|---|
Hubspot
| API | Description |
|---|
UserAgentVideo
| API | Description |
|---|
Discord
| API | Description |
|---|
WizardV2
| API | Description |
|---|---|
| POST api/v2/wizard/create |
Creates a new user profile using the wizard, setting up initial configurations, design, and notification settings. |
| GET api/v2/wizard/username |
Retrieves a random username for suggestion during the wizard process. |
| GET api/v2/wizard |
Retrieves the default profile setup and state for the wizard process (step 0). |
| POST api/v2/wizard/claim |
Claims a profile by assigning a username and updating profile details. |
| POST api/v2/wizard/2 |
Adds social links to a user's profile during the wizard setup process. |
| POST api/v2/wizard/3 |
Allows a user to choose categories for their profile during the wizard setup process. |
| POST api/v2/wizard/4 |
Finalizes the wizard setup by allowing a user to choose a template for their profile. |
CardBlock
| API | Description |
|---|
Wordpress
| API | Description |
|---|
EmailSignature
| API | Description |
|---|
ContentPlacement
| API | Description |
|---|---|
| POST api/profiles/{profileId}/content/{contentId}/placements |
Links content to a specific location (block or tab) by creating a placement entry. |
| DELETE api/profiles/{profileId}/content/{contentId}/placements/{placementId} |
Removes a content placement, unlinking the content from a specific block or tab. |
AiContent
| API | Description |
|---|---|
| POST api/profiles/{profileId}/ai/contents |
Generates AI-powered content and saves it under the specified profile. |
| POST api/profiles/{profileId}/ai/contents/{id}/generate |
Generates AI-powered text based on the existing AI content and updates the entry. |
| GET api/profiles/{profileId}/ai/contents/settings |
Retrieves AI content settings for a specific profile. |
| PUT api/profiles/{profileId}/ai/contents/settings |
Updates AI content settings including default prompt for content generation. |
| PUT api/profiles/{profileId}/ai/contents/{id}/image |
Updates the image associated with a specific AI-generated content entry. |
| PUT api/profiles/{profileId}/ai/contents/{id}/script |
Updates the script content of an AI-generated entry. |
| PUT api/profiles/{profileId}/ai/contents/{id}/caption |
Updates the caption of an AI-generated content entry. |
| GET api/profiles/{profileId}/ai/contents |
Retrieves a list of all AI-generated contents for a specific profile. |
| DELETE api/profiles/{profileId}/ai/contents/{id} |
Permanently deletes an AI-generated content entry from a profile. |
SliderBlock
| API | Description |
|---|---|
| PUT api/slider-blocks/{blockId} |
Updates an existing slider block with new data. |
| PUT api/slider-blocks/{blockId}/design |
Updates the design settings of a slider block. |
| POST api/slider-blocks/{blockId}/items |
Adds a new item to a slider block. |
| PUT api/slider-blocks/{blockId}/items/{id} |
Updates an existing item in a slider block. |
| PUT api/slider-blocks/{blockId}/items/sort |
Updates the order of items within a slider block. |
| DELETE api/slider-blocks/{blockId}/items/{id} |
Deletes a slider item from a slider block. |
CampaignMedia
| API | Description |
|---|
Album
| API | Description |
|---|
LiveChat
| API | Description |
|---|
Giveaway
| API | Description |
|---|
FeatureBlock
| API | Description |
|---|---|
| PUT api/feature-blocks/{blockId} |
Updates the main content (title, description, image) of a feature block. |
| PUT api/feature-blocks/{blockId}/design |
Updates the display settings (view and layout) for a feature block. |
| POST api/feature-blocks/{blockId}/items |
Adds a new feature item (point) to a block. |
| PUT api/feature-blocks/{blockId}/items/{id} |
Updates an existing feature item's details. |
| PUT api/feature-blocks/{blockId}/items/sort |
Updates the sorting order of feature items within a block. |
| DELETE api/feature-blocks/{blockId}/items/{id} |
Permanently deletes a feature item from its block. |
ChatAiBlock
| API | Description |
|---|---|
| POST api/chat-ai-blocks/{blockId}/items |
Links a new data source (text excerpt, uploaded file, or web URL) to the ChatAI knowledge base. |
| PUT api/chat-ai-blocks/{blockId}/items/{itemId} |
Modifies an existing data source item's content or type in the ChatAI block. |
| GET api/chat-ai-blocks/{blockId}/items |
Returns all data sources (texts, files, URLs) currently attached to a target ChatAI block. |
| GET api/chat-ai-blocks/{blockId}/items/{itemId} |
Fetches detailed metadata for a single specific data source in the ChatAI block. |
| PUT api/chat-ai-blocks/{blockId}/items/sort |
Updates the manual display order of data sources within the ChatAI settings. |
| DELETE api/chat-ai-blocks/{blockId}/items/{itemId} |
Permanently removes a data source from the ChatAI block's knowledge base. |
| POST api/chat-ai-blocks/{blockId}/suggestions |
Adds a sample clickable question ("suggestion") to help users interact with the ChatAI. |
| PUT api/chat-ai-blocks/{blockId}/suggestions/{suggestionId} |
Updates the text, order, or visibility of a specific helper suggestion. |
| GET api/chat-ai-blocks/{blockId}/suggestions |
Retrieves all helper suggestions associated with a ChatAI block. |
| GET api/chat-ai-blocks/{blockId}/suggestions/{suggestionId} |
Retrieves detailed metadata for a specific helper suggestion in the ChatAI block. |
| PUT api/chat-ai-blocks/{blockId}/suggestions/sort |
Updates the manual display order of helper suggestions within the ChatAI settings. |
| DELETE api/chat-ai-blocks/{blockId}/suggestions/{suggestionId} |
Permanently removes a helper suggestion from the ChatAI block. |
EmailQueue
| API | Description |
|---|
ShoutoutBlock
| API | Description |
|---|
TrustBlock
| API | Description |
|---|---|
| PUT api/trust-blocks/{blockId} |
Updates an existing trust block with new data. |
| PUT api/trust-blocks/{blockId}/design |
Updates the design settings of a trust block. |
| POST api/trust-blocks/{blockId}/items |
Adds a new trust item to a trust block. |
| PUT api/trust-blocks/{blockId}/items/{id} |
Updates an existing trust item. |
| PUT api/trust-blocks/{blockId}/items/sort |
Sorts trust items within a block. |
| DELETE api/trust-blocks/{blockId}/items/{id} |
Deletes a trust item. |
EventBlock
| API | Description |
|---|---|
| PUT api/event-blocks/{blockId} |
Updates the core header information (title, description, and image) for an event block. |
| PUT api/event-blocks/{blockId}/design |
Updates the functional layout and orientation settings for the event block. |
| POST api/profiles/{profileId}/events |
Creates a new event record (concert, meeting, webinar) and assigns it to a profile. |
| PUT api/profiles/{profileId}/events/{id} |
Updates an existing event's details, including time, location (with potential Google/Zoom synchronization), and SEO metadata. |
| GET api/profiles/{profileId}/events/{id} |
Retrieves detailed information for a single specific event, including its display context. |
| DELETE api/profiles/{profileId}/events/{id} |
Permanently removes an event and its associated calendar integration data. |
| PUT api/event-blocks/{blockId}/items/sort |
Updates the manual display order of events within the block. |
| PUT api/profiles/{profileId}/events/{itemId}/checkout/fields |
Configures which customer data fields (identity, contact) are required to book the event. |
| POST api/profiles/{profileId}/events/{id}/submit |
Finalizes an event registration/booking with customer identity and chosen payment method. |
ContentCalendar
| API | Description |
|---|
PublicShortLink
| API | Description |
|---|
PremiumInboxBlock
| API | Description |
|---|
TelegramReplyAutomation
| API | Description |
|---|
MediaKitBlock
| API | Description |
|---|
DeliveryMethods
| API | Description |
|---|
TemplateMarketplaceWebhook
| API | Description |
|---|
Video
| API | Description |
|---|---|
| GET api/profiles/{profileId}/videos?take={take}&skip={skip} |
Retrieves videos from a profile with pagination support. |
| DELETE api/profiles/{profileId}/videos/{id} |
Deletes a video from a profile. |
OAuthConnector
| API | Description |
|---|
Checkouts
| API | Description |
|---|
ManualPaymentMethods
| API | Description |
|---|
Notification
| API | Description |
|---|---|
| POST api/profiles/{profileId}/notifications/{id}/read |
Marks a specific notification as read by updating its state and setting a timestamp. |
| POST api/profiles/{profileId}/notifications/read |
Marks all notifications for a specific profile as read in a single operation. |
| POST api/profiles/{profileId}/lead-notifications/read |
Marks all unread lead generation notifications as read for a specific profile. |
| POST api/profiles/{profileId}/chat-notifications/read |
Marks all unread chat or direct message notifications as read for a specific profile. |
CrmActivity
| API | Description |
|---|
Chat
| API | Description |
|---|---|
| POST api/profiles/{profileId}/messages/anonymous |
Sends an anonymous message to a profile, creating an audience member for tracking if necessary. |
| POST api/messages |
Sends a standard message within a chat between two profiles. |
| PUT api/messages/{messageId} |
Updates the content of an existing chat message. |
| GET api/messages/{messageId} |
Retrieves detailed information for a specific chat message. |
| DELETE api/messages/{messageId} |
Permanently deletes a specific chat message. |
| GET api/profiles/{profileId}/chats/{chatId}/messages?take={take}&skip={skip} |
Retrieves a paginated list of messages for a specific chat within a profile. |
| POST api/admin/messages/bulk |
Sends a bulk message to all profiles as an administrator. |
| POST api/messages/bulk |
Initiates a bulk message broadcast to a profile's associated audience. |
TwitterBlock
| API | Description |
|---|---|
| PUT api/twitter-blocks/{blockId} |
Updates an existing Twitter block with new data. |
GalleryBlock
| API | Description |
|---|---|
| PUT api/gallery-blocks/{blockId} |
Updates the main heading and alignment settings for a gallery block. |
| PUT api/gallery-blocks/{blockId}/design |
Updates the visual layout and display view of the gallery. |
| POST api/gallery-blocks/{blockId}/media |
Uploads and adds one or more media files to the gallery block. |
| PUT api/gallery-blocks/{blockId}/media/{id} |
Replaces the file/image for an existing gallery media item. |
| DELETE api/gallery-blocks/{blockId}/media/{mediaId} |
Permanently deletes a media item from the gallery block. |
ContactBlock
| API | Description |
|---|---|
| GET api/contacts/enum |
Retrieves a list of supported contact types (e.g., Email, WhatsApp, Instagram). |
| PUT api/contact-blocks/{blockId} |
Updates the core information (title, description, and button text) for a contact block. |
| PUT api/contact-blocks/{blockId}/design |
Updates the functional layout and orientation settings for the contact block. |
| POST api/contact-blocks/{blockId}/items |
Links a new specific contact method (e.g., a phone number or social link) to the block. |
| PUT api/contact-blocks/{blockId}/items/{itemId} |
Updates a specific contact method's details (e.g., changing the email address or display name). |
| PUT api/contact-blocks/{blockId}/items/sort |
Updates the manual display order of contact methods in the block. |
| DELETE api/contact-blocks/{blockId}/items/{itemId} |
Permanently removes a specific contact method from the block. |
TimerBlock
| API | Description |
|---|---|
| PUT api/timer-blocks/{blockId} |
Updates an existing timer block with new data. |
| PUT api/timer-blocks/{blockId}/design |
Updates the design settings of a timer block. |
Mfa
| API | Description |
|---|
ContentPost
| API | Description |
|---|
UnlockBlock
| API | Description |
|---|---|
| PUT api/unlock-blocks/{blockId} |
Updates the content and heading properties of an unlock block. |
| POST api/unlock-blocks/{blockId}/items |
Adds a new content item to the specified unlock block. |
| PUT api/unlock-blocks/{blockId}/items/{id} |
Updates an existing content item within a specified unlock block. |
| GET api/unlock-blocks/{blockId}/items/{id} |
Retrieves a specific content item within a given unlock block. |
| DELETE api/unlock-blocks/{blockId}/items/{id} |
Deletes a specific content item from a given unlock block. |
| PUT api/unlock-blocks/{blockId}/items/sort |
Sorts the content items within a specified unlock block. |
InstagramBlock
| API | Description |
|---|---|
| PUT api/instagram-blocks/{blockId} |
Updates the general information (title, description, images) of an Instagram block. |
| PUT api/instagram-blocks/{blockId}/design |
Updates the visual display modes (Carousel, Grid) and layout styles for an Instagram block. |
| PUT api/instagram-blocks/{blockId}/settings |
Updates functional settings like automated content polling for the specified Instagram block. |
| GET api/profiles/{profileId}/instagram-accounts |
Fetches all Instagram accounts currently connected to a specific profile. |
| POST api/instagram-blocks/{blockId}/instagram-accounts/{id}/bind |
Connects an Instagram account to an Instagram block and binds its media. |
| POST api/profiles/{profileId}/instagram-accounts |
Connects a public Instagram account to the user's profile using the scraper service. |
| POST api/instagram-blocks/{blockId}/connect |
Simultaneously connects an Instagram account to a block and initiates an immediate media scrape. |
| DELETE api/instagram-blocks/{blockId}/disconnect |
Disconnects an Instagram account from a block, removing post bindings and stopping updates. |
| GET api/instagram-blocks/{blockId}/media/{id} |
Retrieves full details for a single Instagram media post, including captions and timestamps. |
| PUT api/instagram-blocks/{blockId}/media/{id} |
Updates a post's content or metadata from the local database. |
DigitalBlock
| API | Description |
|---|---|
| PUT api/digital-blocks/{blockId} |
Updates the core header information (title, description, and image) for a digital products block. |
| PUT api/digital-blocks/{blockId}/design |
Updates the functional layout and orientation settings for the digital products block. |
| GET api/profiles/{username}/digitals/{slug}/slug |
Retrieves a digital product's details using its URL-friendly slug and profile username. |
| GET api/profiles/{profileId}/digitals/{productId} |
Retrieves a single digital product's full data by its ID and profile ID. |
| PUT api/profiles/{profileId}/digitals/{productId}/status |
Toggles the active status of a digital product, controlling its visibility on the public profile. |
| PUT api/profiles/{profileId}/digitals/{productId}/slug |
Updates the unique URL identifier (slug) for a digital product. |
| POST api/profiles/{profileId}/digitals |
Creates a new digital product (e.g., e-book, file, guide) and attaches it to a profile. |
| PUT api/profiles/{profileId}/digitals/{productId} |
Updates an existing digital product's content, metadata, labels, and internal design settings. |
| DELETE api/profiles/{profileId}/digitals/{productId} |
Permanently removes a digital product from the profile. |
| PUT api/digital-blocks/{blockId}/items/sort |
Updates the manual display order of digital products within the block. |
| PUT api/profiles/{profileId}/digitals/{productId}/checkout/fields |
Configures which customer data fields (identity, contact) are required during checkout for the digital product. |
| POST api/profiles/{profileId}/digitals/checkout-session?id={id} |
Generates a Stripe checkout session URL for a specific order. |
| POST api/profiles/{profileId}/digitals/{productId}/submit |
Submits a purchase request for a digital product with customer details. |
Upload
| API | Description |
|---|---|
| POST api/profiles/{profileId}/upload |
Uploads an image to a profile's media library. |
| POST api/profiles/{profileId}/upload/url |
Uploads an image from a URL to a profile's media library. Accepts .jpg, .jpeg, .png, .gif, .bmp, and .webp formats. |
| POST api/profiles/{profileId}/upload/crop |
Uploads and crops an image according to specified dimensions using an improved algorithm. |
| POST api/profiles/{profileId}/upload/crop/gif |
Crops a GIF image based on specified coordinates and dimensions. |
| GET api/profiles/{profileId}/video/thumbnail?url={url} |
Retrieves a thumbnail image for a video URL. |
| POST api/profiles/{profileId}/upload/video |
Uploads a video file and processes it for use in the platform. |
| POST api/profiles/{profileId}/upload/video/url |
Uploads a video from a URL and processes it for use in the platform. |
MapBlock
| API | Description |
|---|---|
| PUT api/map-blocks/{blockId} |
Updates an existing map block with new data. |
| PUT api/map-blocks/{blockId}/design |
Updates the design settings of a map block. |
| POST api/map-blocks/{blockId}/items |
Adds a new item to a map block. |
| PUT api/map-blocks/{blockId}/items/{id} |
Updates an existing map item with new data. |
| DELETE api/map-blocks/{blockId}/items/{id} |
Deletes an existing map item from a map block. |
YouTubeBlock
| API | Description |
|---|---|
| PUT api/youtube-blocks/{blockId} |
Updates the core information (title, description, dividers) of a YouTube block. |
| PUT api/youtube-blocks/{blockId}/design |
Updates the layout and visual orientation (grid, list, etc.) of the YouTube block. |
| POST api/youtube-blocks/{blockId}/media |
Scrapes and adds a new YouTube video or channel feed to the block based on the provided URL. |
| PUT api/youtube-blocks/{blockId}/media/{mediaId} |
Toggles the active/visible state of a specific YouTube media item in the block. |
| PUT api/youtube-blocks/{blockId}/media/sort |
Updates the manual display order of YouTube media items within the block. |
| DELETE api/youtube-blocks/{blockId}/media/{mediaId} |
Removes a specific YouTube media item from the block. |
| PUT api/youtube-blocks/{blockId}/media/{mediaId}/tag |
Creates or updates a clickable product tag (label) on a specific YouTube media item. |
| DELETE api/youtube-blocks/{blockId}/media/{mediaId}/tag/{tagId} |
Deletes an associated product tag from a YouTube media item. |
| POST api/profiles/{profileId}/youtube-accounts |
Connects a new YouTube account/channel to the user's profile to track and display content. |
| GET api/profiles/{profileId}/youtube-accounts |
Fetches all YouTube channels and accounts linked to the user's profile. |
SingleProductBlock
| API | Description |
|---|
CrowdfundingBlock
| API | Description |
|---|
Telegram
| API | Description |
|---|---|
| POST api/profiles/{profileId}/telegram/channel |
Adds a Telegram channel to a profile. |
| GET api/profiles/{profileId}/telegram/channel?token={token}&username={username} |
Retrieves information about a Telegram channel. |
GlobalStyle
| API | Description |
|---|
| API | Description |
|---|---|
| GET api/profiles/{profileId}/facebook/users |
Retrieves a list of Facebook users associated with a profile. |
| GET api/profiles/{profileId}/facebook/pages |
Retrieves a list of Facebook pages associated with a profile. |
| GET api/profiles/{profileId}/facebook/{cid}/metrics |
Retrieves metrics for a specific Facebook post. |
MusicBlock
| API | Description |
|---|---|
| PUT api/music-blocks/{blockId} |
Updates an existing music block with new data. |
| POST api/music-blocks/{blockId}/items |
Adds a new music item to a music block. |
| PUT api/music-blocks/{blockId}/items/{id} |
Updates an existing music item with new data. |
| PUT api/music-blocks/{blockId}/items/sort |
Updates the order of items within a music block. |
| DELETE api/music-blocks/{blockId}/items/{id} |
Deletes an existing music item from a music block. |
Notion
| API | Description |
|---|
MyStickerPacks
| API | Description |
|---|
AutomationLog
| API | Description |
|---|
UniLink
| API | Description |
|---|---|
| GET api/user?username={username} |
Retrieves account website data in JSON format. |
| GET api/user/revalidate?username={username} |
Revalidates a user profile by username and triggers cache invalidation. |
| GET api/user/{username}/update |
Updates and retrieves the latest account website data in JSON format. |
| PUT api/profiles/{profileId}/username |
Changes the username of an account. |
| POST api/profiles/{profileId}/default |
Sets a profile as the default/primary user account on the dashboard. |
UserAgentBrowser
| API | Description |
|---|
ProfileMcpServers
| API | Description |
|---|
ProfileAgent
| API | Description |
|---|
QrCode
| API | Description |
|---|---|
| POST api/profiles/{profileId}/qrcodes |
Creates a new QR code with a tracked short URL and unique redirection slug. |
| PUT api/profiles/{profileId}/qrcodes/{id} |
Updates the configuration, destination URL, and visual slug of an existing QR code. |
| GET api/profiles/{profileId}/qrcodes |
Retrieves a complete list of all QR codes generated for a specific user profile. |
| GET api/profiles/{profileId}/qrcodes/{id} |
Retrieves detailed metadata for a specific QR code by its primary identifier. |
| GET api/profiles/{profileId}/qrcodes/{slug}/slug |
Retrieves details for a specific QR code using its unique URL slug. |
| DELETE api/profiles/{profileId}/qrcodes/{id} |
Permanently deletes a specific QR code and its associated tracking metadata. |
AiCredits
| API | Description |
|---|
SocialPages
| API | Description |
|---|
PricingBlock
| API | Description |
|---|---|
| PUT api/pricing-blocks/{blockId} |
Updates the content and heading properties of a pricing block. |
| PUT api/pricing-blocks/{blockId}/design |
Updates the design settings (view, layout) of a pricing block. |
| POST api/pricing-blocks/{blockId}/items |
Adds a new pricing item to the specified pricing block. |
| PUT api/pricing-blocks/{blockId}/items/{id} |
Updates an existing pricing item within a specified pricing block. |
| GET api/pricing-blocks/{blockId}/items/{id} |
Retrieves a specific pricing item within a given pricing block. |
| DELETE api/pricing-blocks/{blockId}/items/{id} |
Deletes a specific pricing item from a given pricing block. |
| PUT api/pricing-blocks/{blockId}/items/sort |
Sorts the pricing items within a specified pricing block. |
| POST api/pricing-blocks/{blockId}/groups |
Adds a new pricing group to the specified pricing block. |
| PUT api/pricing-blocks/{blockId}/groups/{id} |
Updates an existing pricing group within a specified pricing block. |
| PUT api/pricing-blocks/{blockId}/groups |
Updates multiple pricing groups within a specified pricing block. |
| GET api/pricing-blocks/{blockId}/groups/{id} |
Retrieves a specific pricing group within a given pricing block. |
| GET api/pricing-blocks/{blockId}/groups |
Retrieves all pricing groups associated with a specified pricing block. |
| GET api/pricing-blocks/{blockId}/groups/{id}/items |
Retrieves all pricing items associated with a specific pricing group within a given pricing block. |
| DELETE api/pricing-blocks/{blockId}/groups/{id} |
Deletes a specific pricing group from a given pricing block. |
EmbedProduct
| API | Description |
|---|
Mcp
| API | Description |
|---|
MusicPresave
| API | Description |
|---|
AutoLiveSubscription
| API | Description |
|---|
ServiceBlock
| API | Description |
|---|---|
| PUT api/service-blocks/{blockId} |
Updates the properties of a specific service block. |
| PUT api/service-blocks/{blockId}/design |
Updates the design settings of a specific service block. |
| POST api/profiles/{profileId}/services |
Adds a new service item to a profile or a specific service block. |
| PUT api/profiles/{profileId}/services/{itemId} |
Updates an existing service product linked to a profile. |
| GET api/profiles/{profileId}/services/{itemId} |
Retrieves details of a specific service item within a profile. |
| DELETE api/profiles/{profileId}/services/{itemId} |
Deletes a specific service item from a profile. |
| PUT api/service-blocks/{blockId}/items/sort |
Sorts service items within a service block based on the specified order. |
| PUT api/profiles/{profileId}/services/{itemId}/checkout/fields |
Updates the checkout fields for a specific service item. |
| POST api/profiles/{profileId}/services/checkout-session?id={id} |
Initiates a checkout session for a service order using Stripe. |
| POST api/profiles/{profileId}/services/{itemId}/submit |
Submits an order for a service item, processing customer details and payment configuration. |
OutfitBlock
| API | Description |
|---|---|
| PUT api/outfit-blocks/{blockId} |
Updates the settings of an outfit block. |
| POST api/profiles/{profileId}/outfits |
Creates and saves a new outfit in a profile. |
| GET api/profiles/{profileId}/outfits/{id} |
Retrieves a specific outfit from a profile by its identifier. |
| PUT api/profiles/{profileId}/outfits/{id} |
Updates an existing outfit in a profile. |
| DELETE api/profiles/{profileId}/outfits/{id} |
Deletes an existing outfit from a profile along with its associated products. |
| POST api/profiles/{profileId}/outfits/{id}/products |
Adds a product to an outfit in a profile. |
| DELETE api/profiles/{profileId}/outfits/{id}/products/{productId} |
Deletes a product from an outfit in a profile. |
Member
| API | Description |
|---|
BrandColors
| API | Description |
|---|
BannerBlock
| API | Description |
|---|---|
| GET api/banner-blocks/{blockId}/hero?select={select}&productId={productId} |
Fetches hero-style content (large image, title, action button) for the banner based on a product or manual selection. |
VCardCapture
| API | Description |
|---|
LinkNotify
| API | Description |
|---|
OrderFormBlock
| API | Description |
|---|
Passkey
| API | Description |
|---|
LiveStreamBlock
| API | Description |
|---|
UserAgentContent
| API | Description |
|---|
BrandStudio
| API | Description |
|---|
AdminCampaign
| API | Description |
|---|
EventReport
| API | Description |
|---|
CampaignPublishing
| API | Description |
|---|
PageListBlock
| API | Description |
|---|---|
| POST api/page-list-blocks/{blockId}/items |
Adds a new item to a Page List block. |
| PUT api/page-list-blocks/{blockId}/items/{id} |
Updates an existing item in a Page List block. |
| GET api/page-list-blocks/{blockId}/items/{id} |
Retrieves a specific Page List item from a block by its identifier. |
| DELETE api/page-list-blocks/{blockId}/items/{id} |
Deletes a specific Page List item from a block. |
| PUT api/page-list-blocks/{blockId}/items/sort |
Sorts the items of a Page List block. |
Funnel
| API | Description |
|---|
Automation
| API | Description |
|---|
CustomBlock
| API | Description |
|---|
AttributionReporting
| API | Description |
|---|
TwitchBlock
| API | Description |
|---|---|
| PUT api/twitch-blocks/{blockId} |
Updates a Twitch block with new data. |
PublicTemplates
| API | Description |
|---|
YoutubeWebhook
| API | Description |
|---|
GoogleFeed
| API | Description |
|---|
AppointmentLifecycle
| API | Description |
|---|
Payments
| API | Description |
|---|---|
| GET api/profiles/{profileId}/payments |
Retrieves a chronological list of all payments received for a specific user profile. |
| GET api/profiles/{profileId}/payments/{id} |
Retrieves a filtered set of payments for a profile, typically used for deep-linking to a specific transaction. |
| GET api/profiles/{profileId}/payments/result?order_ref={order_ref}&sign={sign} |
Decodes and processes the incoming payment signature and order reference to confirm transaction success and prepare the post-purchase UI state. |
| GET api/profiles/{profileId}/payments/config |
Retrieves the complete payment configuration for a profile, including enabled gateways (Stripe, PayPal, etc.) and wallet status. |
| POST api/profiles/{profileId}/payments/withdraw |
Submits a request to withdraw accumulated funds from the profile balance to a selected payout method. |
LegalDocuments
| API | Description |
|---|
Zapier
| API | Description |
|---|---|
| GET api/zapier/me?apiKey={apiKey} |
Retrieves a profile using the provided API key. |
| POST api/zapier/subscribe/new_email?apiKey={apiKey} |
Subscribes a Zapier webhook to receive notifications for new email events. |
| DELETE api/zapier/unsubscribe/new_email?apiKey={apiKey} |
Unsubscribes a Zapier webhook from new email notifications. |
| GET api/zapier/perform/new_email?apiKey={apiKey} |
Tests the webhook by performing a sample email notification trigger. |
User
| API | Description |
|---|---|
| GET api/user/refresh?username={username}&callback={callback} |
Refreshes the user cache for a specified username. |
| GET api/users |
Get information about user accounts. Primarily, it fetches the details of a default website tied to the user's account. Also retrieves basic information such as notification settings, visitor statistics, and lead response metrics, for that default account. The method also retrieves a list of other websites associated with the user. |
| GET api/users/apikey |
Generate a new application's API key for the authenticated user. |
| GET api/users/dashboard |
Retrieves dashboard statistics for all profiles owned by the authenticated user. |
| PUT api/users/settings |
Updates the settings of the authenticated user. |
| DELETE api/users/{id} |
Deletes a user account and all associated profiles and data. |
Agent
| API | Description |
|---|
Import
| API | Description |
|---|
SinglePages
| API | Description |
|---|
GoogleSheet
| API | Description |
|---|---|
| GET api/googlesheet |
Retrieves a list of Google Spreadsheet titles available to the authenticated user's account. |
| GET api/googlesheets |
Retrieves detailed information (ID and Title) for all Google Spreadsheets available to the user. |
AiSiteBuilder
| API | Description |
|---|
Translations
| API | Description |
|---|
GoogleCalendar
| API | Description |
|---|---|
| GET callback/calendar?state={state}&code={code}&scope={scope} |
Handles the OAuth2 callback from Google, exchanging the authorization code for access and refresh tokens. |
| POST api/calendar/event |
(Debug/Experimental) Creates a new meeting or event in the linked Google Calendar. |
| DELETE api/calendar/event/delete?eventId={eventId} |
(Debug/Experimental) Removes a specific event from the user's linked Google Calendar. |
| DELETE api/calendar/disconnect |
Revokes access and unlinks the Google account from the user's profile. |
| POST api/calendar/event/{eventId}/addUser |
(Experimental) Adds a guest (via email) to an existing Google Calendar event. |
ProfileLiveStream
| API | Description |
|---|
AutoDm
| API | Description |
|---|
MenuBlock
| API | Description |
|---|---|
| PUT api/menu-blocks/{blockId} |
Updates an existing menu block with new content settings. |
| PUT api/menu-blocks/{blockId}/design |
Updates the design settings of a menu block. |
| POST api/menu-blocks/{blockId}/categories |
Adds a new category to organize menu items within a menu block. |
| PUT api/menu-blocks/{blockId}/categories/{categoryId} |
Updates an existing menu category with new information. |
| PUT api/menu-blocks/{blockId}/categories/sort |
Updates the display order of menu categories within a menu block. |
| DELETE api/menu-blocks/{blockId}/categories/{categoryId} |
Deletes a menu category from a menu block. |
| POST api/menu-blocks/{blockId}/items |
Adds a new menu item (dish/product) to a menu block. |
| PUT api/menu-blocks/{blockId}/items/{itemId} |
Updates an existing menu item with new information. |
| PUT api/menu-blocks/{blockId}/items/sort |
Updates the display order of menu items within a menu block. |
| DELETE api/menu-blocks/{blockId}/items/{itemId} |
Deletes a menu item and its associated properties from a menu block. |
| GET api/profiles/{profileId}/menu-item-properties |
Retrieves all custom properties available for menu items in a profile. |
| POST api/profiles/{profileId}/menu-item-properties |
Creates a new custom property that can be applied to menu items. |
TikTokWebhook
| API | Description |
|---|
Integration
| API | Description |
|---|---|
| GET api/profiles/{profileId}/integration |
Retrieves social media integration status for a specific profile. |
| GET api/profiles/{profileId}/integration/{type}/{id}/test |
Tests the connection to a specific social media platform. |
| DELETE api/profiles/{profileId}/integration/{type}/{id} |
Deletes a social media integration from a profile. |
| POST api/profiles/{profileId}/integration/pro?id={id} |
Requests activation of pro features for a specific social media integration. |
UserAgent
| API | Description |
|---|
ExternalBlock
| API | Description |
|---|---|
| GET api/profiles/{username}/externals/{slug}/slug |
Retrieves external product details by profile username and product slug. |
| GET api/profiles/{profileId}/externals/{productId} |
Retrieves external product details by profile ID and product ID. |
| PUT api/profiles/{profileId}/externals/{productId} |
Updates the configuration, metadata, and platform details of an existing external product. |
| DELETE api/profiles/{profileId}/externals/{productId} |
Permanently deletes an external product from a profile. |
| PUT api/profiles/{profileId}/externals/{itemId}/slug |
Updates the URL slug for an external product. |
WizardOpenV1
| API | Description |
|---|---|
| POST api/profiles/create-via-partner |
Creates a new profile via a partner integration. This method is typically used by partner accounts to automate profile creation for their users. |
Cta
| API | Description |
|---|---|
| POST api/profiles/{profileId}/cta |
Creates a new call-to-action (CTA) configuration for a profile element (block, item, or page). |
| PUT api/profiles/{profileId}/cta/{id} |
Updates an existing call-to-action (CTA) configuration. |
| DELETE api/profiles/{profileId}/cta/{id} |
Permanently removes a call-to-action (CTA) configuration. |
ProfileFollower
| API | Description |
|---|
DisplayIdentity
| API | Description |
|---|
CtaHelper
| API | Description |
|---|---|
| GET api/profiles/{profileId}/cta-helper/links |
Retrieves external or internal links from link blocks that can be used as CTA destinations. |
| GET api/profiles/{profileId}/cta-helper/pages |
Retrieves all public pages from a profile, allowing them to be selected as CTA targets. |
| GET api/profiles/{profileId}/cta-helper/block-types?action={action} |
Retrieves available block types (Header, Bio, Music, etc.) that support CTA actions. |
| GET api/profiles/{profileId}/cta-helper/products?type={type} |
Retrieves all commercial products (Shop, Digital, Services) that can be targeted by a CTA button. |
| GET api/profiles/{profileId}/cta-helper/blocks |
Retrieves all active blocks across all pages to be used as 'Scroll to' or 'Open' CTA targets. |
| GET api/profiles/{profileId}/cta-helper/items?type={type} |
Retrieves specific items (links, FAQ entries, menu items) within a block type to be used as granular CTA targets. |
AdminBlog
| API | Description |
|---|
PodcastBlock
| API | Description |
|---|---|
| PUT api/podcast-blocks/{blockId} |
Updates the content and general settings of a Podcast block. |
| POST api/podcast-blocks/{blockId}/items |
Adds a new podcast item (audio episode) to a specific Podcast block. |
| PUT api/podcast-blocks/{blockId}/items/{id} |
Updates an existing podcast item's details, order, or active status. |
| GET api/podcast-blocks/{blockId}/items/{id} |
Retrieves a specific podcast item's details by its ID. |
| DELETE api/podcast-blocks/{blockId}/items/{id} |
Permanently deletes a specific podcast item from a block. |
| PUT api/podcast-blocks/{blockId}/items/sort |
Sorts podcast items within a block by updating their position indices. |
Photo
| API | Description |
|---|---|
| DELETE api/profiles/{profileId}/photos/{id} |
Permanently deletes a specific photo from a profile's media gallery. |
TeamBoardSnapshot
| API | Description |
|---|
ApiKeys
| API | Description |
|---|
BrowserSites
| API | Description |
|---|
AmaBlock
| API | Description |
|---|
HtmlBlock
| API | Description |
|---|---|
| PUT api/html-blocks/{blockId} |
Updates an existing HTML block with new content. |
AdAccounts
| API | Description |
|---|
PublicHelpApi
| API | Description |
|---|
FaqBlock
| API | Description |
|---|---|
| POST api/faq-blocks/{blockId}/items |
Adds a new FAQ question and answer item to a block. |
| PUT api/faq-blocks/{blockId}/items/{id} |
Updates an existing FAQ question, answer, or icon. |
| PUT api/faq-blocks/{blockId}/items/sort |
Updates the sorting order of FAQ items within a block. |
| DELETE api/faq-blocks/{blockId}/items/{id} |
Permanently deletes an FAQ item from its block. |
EmbedPost
| API | Description |
|---|
Settings
| API | Description |
|---|---|
| GET api/settings/timezonenet |
Retrieves a prioritized list of global time zones supported by the underlying .NET system. |
| GET api/settings/deny |
Returns a 401 Unauthorized response for testing or explicit denial purposes. |
| GET api/settings |
Retrieves core account metadata, subscription plan details, and resource limits for the authenticated user. |
| DELETE api/profiles/{profileId}/instagram/{id}/disconnect |
Permanently removes a linked Instagram account from a profile, including all associated media cache, content blocks, and entity bindings. |
| GET api/spreadsheet/auth |
Generates an external Google OAuth2 authorization URL to initiate a Google Sheets integration. |
| DELETE api/spreadsheet/disconnect |
Revokes access to the user's Google Spreadsheet connection and deletes the associated integration metadata. |
CourseBlock
| API | Description |
|---|---|
| PUT api/course-blocks/{blockId} |
Updates the core header information (title, description, and image) for a course block. |
| PUT api/course-blocks/{blockId}/design |
Updates the functional layout and orientation settings for the course block. |
| POST api/profiles/{profileId}/courses |
Creates a new course and assigns it to a profile. |
| PUT api/profiles/{profileId}/courses/{itemId} |
Updates an existing course's details (title, price, bio, images) and its visibility status. |
| GET api/profiles/{profileId}/courses/{itemId}/verify?key={key} |
Validates a course purchase and grants access based on a unique transaction key. |
| GET api/profiles/{profileId}/courses/{itemId} |
Retrieves detailed information for a single specific course, including currency and language context. |
| PUT api/course-blocks/{blockId}/items/sort |
Updates the manual display order of course items within the block. |
| DELETE api/profiles/{profileId}/courses/{itemId} |
Deletes a course and all associated modules, lessons, and attachments. |
| POST api/profiles/{profileId}/courses/{courseId}/modules |
Creates a new module within a course. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/{moduleId} |
Updates an existing coarse module's text and active state. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/sort |
Updates the manual display order of modules within a course. |
| DELETE api/profiles/{profileId}/courses/{courseId}/modules/{moduleId} |
Deletes a module and all its associated lessons and attachments. |
| POST api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons |
Creates a new lesson within a course module. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId} |
Updates an existing lesson's content, including its title, description, and video link. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/sort |
Updates the manual display order of lessons within a specific course module. |
| DELETE api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId} |
Deletes a lesson and all its attachments. |
| POST api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId}/attachments |
Links a downloadable file to a specific lesson, optionally setting an expiration date. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId}/attachments/{attachmentId} |
Updates an existing lesson attachment. |
| PUT api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId}/attachments/sort |
Updates the order of attachments within a lesson. |
| DELETE api/profiles/{profileId}/courses/{courseId}/modules/{moduleId}/lessons/{lessonId}/attachments/{attachmentId} |
Removes a downloadable link from a lesson permanently. |
| PUT api/profiles/{profileId}/courses/{courseId}/checkout/fields |
Configures which customer data fields (identity, contact, address) are required to enroll in the course. |
| POST api/profiles/{profileId}/courses/{courseId}/submit |
Finalizes a course enrollment or purchase using provided customer information and payment method. |
ShortLinkDomain
| API | Description |
|---|
AudienceGroup
| API | Description |
|---|---|
| POST api/audience-groups/{groupId}/members/{memberId} |
Adds an audience member to an audience group. |
| PUT api/audience-groups/{groupId}/members/{memberId} |
Removes an audience member from an audience group. |
| GET api/audience-groups/{groupId}/members |
Retrieves all audience members that belong to a specific group. |
| GET api/audience-groups/members/{memberId}/belongs |
Retrieves all groups that a specific audience member belongs to. |
| POST api/profiles/{profileId}/audience-groups |
Creates a new audience group for a profile. |
| PUT api/audience-groups/{id} |
Updates an existing audience group. |
| GET api/audience-groups/{id} |
Retrieves a specific audience group. |
| GET api/profiles/{profileId}/audience-groups |
Retrieves all audience groups for a specific profile. |
| DELETE api/audience-groups/{id} |
Deletes an audience group and all its member bindings. |
AdCampaigns
| API | Description |
|---|
ReferenceStyle
| API | Description |
|---|
SocialDelivery
| API | Description |
|---|
ContactTag
| API | Description |
|---|
DesignImport
| API | Description |
|---|
PineconeTest
Test controller for populating Pinecone with AI Assistant knowledge
| API | Description |
|---|---|
| POST api/dev/pinecone/upsert-textblock |
Uploads TextBlock knowledge to Pinecone |
| POST api/dev/pinecone/test-query |
Test Pinecone query with a sample text |
| GET api/dev/pinecone/blocks-info |
Get all available blocks info from Pinecone |
CommunityBlock
| API | Description |
|---|
FacebookPlatform
| API | Description |
|---|
ShortBlock
| API | Description |
|---|
ScheduledTasks
| API | Description |
|---|---|
| GET api/profiles/{profileId}/scheduled-tasks/{id} |
Restieves Scheduled Task. |
| GET api/profiles/{profileId}/scheduled-tasks/target/{targetId} |
PromptLibrary
| API | Description |
|---|
TikTokBlock
| API | Description |
|---|---|
| PUT api/tiktok-blocks/{blockId} |
Updates a TikTok block's core identity, including title, description, and heading visuals. |
| PUT api/tiktok-blocks/{blockId}/design |
Updates the visual layout (e.g., Grid vs. Carousel) and orientation of the TikTok content. |
| PUT api/tiktok-blocks/{blockId}/settings |
Toggles automated content synchronization for the specific TikTok block. |
| POST api/tiktok-blocks/{blockId}/connect |
Connects a new TikTok username to a block, scrapes initial media items, and saves account metadata. |
| POST api/tiktok-blocks/{blockId}/connect2?profileId={profileId} |
Links a TikTok account to the user's profile globally (without associating it with a specific block). |
| GET api/profiles/{profileId}/tiktok-accounts |
Returns a list of all TikTok accounts currently linked to the user's profile. |
| POST api/tiktok-blocks/{blockId}/media |
Scrapes and adds a single TikTok video to a block by its direct URL. |
| PUT api/tiktok-blocks/{blockId}/media/{mediaId} |
Updates the visibility (IsActive) of a specific TikTok media item within the block. |
| DELETE api/tiktok-blocks/{blockId}/media/{mediaId} |
Removes a specific video from the TikTok block's collection. |
| PUT api/tiktok-blocks/{blockId}/media/{mediaId}/tags |
Creates or modifies an interactive product tag (linking to a store item) on a specific TikTok video. |
| DELETE api/tiktok-blocks/{blockId}/media/{mediaId}/tags/{tagId} |
Removes a shopping tag link from a TikTok video. |
| GET api/tiktok-blocks/{blockId}/media?id={id}&take={take}&skip={skip} |
Returns a paginated list of all TikTok videos found across the entire profile (not specific to one block). |
| DELETE api/tiktok-blocks/{blockId}/disconnect |
Unlinks the TikTok account from the current block and clears all fetched data local to this block. |
Profile
| API | Description |
|---|---|
| GET api/me |
Retrieves core information for the authenticated user and their active/default profile. |
| GET api/profiles/{profileId}/follow/status |
Retrieves the following status between the authenticated user's profile and a target profile. |
| POST api/profiles/{profileId}/unfollow |
Removes a profile-to-profile subscription, causing the current user to unfollow the target. |
| PUT api/profiles/{profileId} |
Updates the primary profile picture and metadata for a specific user profile. |
| GET api/profiles/{profileId}/media?type={type}&take={take}&skip={skip} |
Retrieves a paginated list of media files (images/videos) associated with a given profile. |
| POST api/profiles/{profileId}/subscribe |
Processes a guest subscription to a profile or specific target (newsletter, membership tier). |
| GET api/profiles/{profileId}/meta |
Aggregates SEO metadata and platform-specific tracking tags (FB, Google Analytics/GTM) for a profile. |
| DELETE api/profiles/{profileId} |
Permanently deletes a profile and marks its associated username for release. |
| GET api/owner/{id} |
Retrieves dashboard statistics (visitors, unread notifications, wallet balance) for the profile owner. |
| GET api/qrcode/download?username={username} |
Generates and serves a JPG QR code file that redirects to the specified user's profile. |
| GET api/qrcode/download/tago?username={username} |
Downloads a QR code generated by the Tago API for the given username. |
| GET api/qrcode/download/link?username={username} |
Generates and serves a JPG QR code file using the direct link formatting for the specified profile. |
| GET api/qrcode/download/link/tago?username={username} |
Generates a QR code for a profile URL using the external Tago API and returns it as a JPG attachment. |
| GET api/qrcode/download/short-link?id={id} |
Generates a QR code for a specific short link identifier, redirecting via the unil.li domain. |
| GET api/qrcode/download/short-link/tago?id={id} |
Generates a QR code for a short link using the Tago API and serves it as a JPG attachment. |
| GET api/qrcode/download/blog?id={id} |
Generates a QR code for a blog post's short link and serves it as a JPG attachment. |
| GET api/qrcode/download/product?id={id} |
Generates a QR code for a product's short link and serves it as a JPG attachment. |
| PUT api/profiles/{profileId}/spotlights |
Updates the spotlight configuration, which displays a prioritized popup of a specific block to new visitors. |
| PUT api/profiles/{profileId}/forwards |
Updates profile-level forward settings to redirect all traffic from the bio page to a specific URL or item. |
| PUT api/profiles/{profileId}/design/navigation |
Schedules a debounced background update for the bio page's navigation bar visual design. |
| PUT api/profiles/{profileId}/design/desktop-mode |
Schedules a debounced background update for the profile's desktop display mode and width settings. |
| PUT api/profiles/{profileId}/design/font |
Schedules a debounced background update for the global typography (font family) of the bio page. |
| PUT api/profiles/{profileId}/design/cover |
Schedules a debounced background update for the profile's page cover image, including WebP conversion and preload optimizations. |
| PUT api/profiles/{profileId}/design/background |
Updates profile background design settings (color, image, gradient, effects). |
| PUT api/profiles/{profileId}/design/background/animation |
Updates background animation settings (type, theme, emoji, palette, pattern). |
| PUT api/profiles/{profileId}/design/template |
Updates the design template settings of a specific profile. |
| PUT api/profiles/{profileId}/design/common |
Updates the common design settings of a specific profile. |
| PUT api/profiles/{profileId}/design/themes |
Updates the theme settings of a specific profile. |
| PUT api/profiles/{profileId}/design/palettes |
Updates a profile's palette with a predefined palette from the system. |
| PUT api/profiles/{profileId}/design/palettes/custom |
Updates a profile with a custom palette generated from specific colors. |
| GET api/animations?take={take}&skip={skip} |
Retrieves a paginated list of available animation backgrounds. |
| GET api/font |
Retrieves all available fonts that can be used for text styling in the application. |
| GET api/templates |
Retrieves a list of available templates with preview information. |
| GET api/themes |
Retrieves a list of available themes. |
| GET api/palettes |
Retrieves a list of available color palettes. |
EmailTemplate
| API | Description |
|---|
Block
| API | Description |
|---|---|
| GET api/enum/blocks |
Retrieves a list of all available block types and their metadata. |
| GET api/sole/block/{sid}?username={username}&type={type} |
Retrieves shared data about a specific block from a profile, typically used for external editing or display. |
| GET api/sole/item/{id}?username={username}&type={type} |
Retrieves data about a specific item within a website block. |
| PUT api/profiles/{profileId}/blocks |
Updates the visibility and display order of multiple blocks within a profile in a batch operation. |
| PUT api/profiles/{profileId}/blocks/{blockId}/schedule |
Configures a visibility schedule for a block, allowing it to be automatically activated or deactivated at specific times. |
| POST api/profiles/{profileId}/blocks/{blockId}/heading-labels |
Updates the design and properties of a label associated with a block heading. |
| POST api/profiles/{profileId}/blocks/initialize |
Initializes a new block for a specific profile page and type. |
| POST api/profiles/{profileId}/blocks/{sid}/copy |
Duplicates a block and all its contents within the specified profile. |
| PUT api/profiles/{profileId}/blocks/{sid}/move |
Moves a block to a different page within the same profile. |
| DELETE api/profiles/{profileId}/blocks/{sid} |
Deletes a block and its associated data (items, settings) based on its type. |
| PUT api/profiles/{profileId}/blocks/{sid}/items/{id}/copy |
Duplicates a specific item within a block (e.g., a single link or image). |
| PUT api/profiles/{profileId}/blocks/{fromBlockId}/items/{id}/move |
Moves a block item from one block to another. |
| PUT api/profiles/{profileId}/blocks/{uid}/rename |
Renames a specific block by updating its internal name/title. |
| PUT api/profiles/{profileId}/blocks2 |
Updates multiple blocks with versioning support to prevent stale updates. (Beta/Draft implementation) |
AppointmentBlock
| API | Description |
|---|---|
| PUT api/appointment-blocks/{blockId} |
Updates appointment block content settings (Calendly token, button text). |
| PUT api/appointment-blocks/{blockId}/design |
Updates the display mode and visual settings of an appointment block. |
| GET api/profiles/{username}/appointments/{slug}/slug |
Retrieves a public appointment item by username and slug for display on profile page. |
| GET api/profiles/{profileId}/appointments/{itemId} |
Retrieves an appointment item by its ID for editing purposes (requires authentication). |
| POST api/profiles/{profileId}/appointments |
Creates a new appointment item in a profile, optionally associated with a block. |
| PUT api/profiles/{profileId}/appointments/{itemId} |
Updates all appointment item details including title, description, pricing, booking method, availability, and design settings. |
| PUT api/appointment-blocks/{blockId}/items/sort |
Reorders appointment items within a block by updating their position indices. |
| DELETE api/profiles/{profileId}/appointments/{itemId} |
Permanently deletes an appointment item from a profile. |
| PUT api/profiles/{profileId}/appointments/{itemId}/availability |
Creates or updates availability time slots for an appointment item on a specific day of the week. |
| PUT api/profiles/{profileId}/appointments/{itemId}/availability/{availabilityId} |
Updates a specific availability time slot for an appointment item. |
| DELETE api/profiles/{profileId}/appointments/{itemId}/availability/{availabilityId} |
Permanently deletes a specific availability time slot from an appointment item. |
| PUT api/profiles/{profileId}/appointments/{itemId}/checkout/fields |
Updates the checkout form fields configuration for an appointment item (name, email, phone, address, custom fields). |
| POST api/profiles/{profileId}/appointments/checkout-session?id={id} |
Creates a Stripe checkout session for an appointment booking (deprecated - use SubmitAppointmentOrder instead). |
| POST api/profiles/{profileId}/appointments/{itemId}/submit |
Submits an appointment booking order with customer information and payment details. Triggers notifications and integrations. |
Files
| API | Description |
|---|---|
| PUT api/profiles/{profileId}/files/{id} |
Updates the metadata and storage information for an existing file attachment. |
| GET api/profiles/{profileId}/files?take={take}&skip={skip} |
Retrieves a paginated list of file attachments associated with a specific profile. |
| DELETE api/profiles/{profileId}/files/{id} |
Deletes a file attachment from a profile. (Note: May be a soft delete depending on repository implementation). |
| DELETE api/profiles/{profileId}/files/{id}/pernamently |
Permanently removes a file attachment and its associated data from the profile. |
HqBoard
| API | Description |
|---|
AppsBlock
| API | Description |
|---|
UserAgentDigest
| API | Description |
|---|
WalletBlock
| API | Description |
|---|---|
| PUT api/wallet-blocks/{blockId} |
Updates an existing wallet block with title and description. |
| PUT api/wallet-blocks/{blockId}/design |
Updates the design settings of a wallet block including view configuration. |
| GET api/wallet-blocks/{blockId}/items |
Retrieves all wallet items associated with a wallet block. |
| POST api/wallet-blocks/{blockId}/items/quick |
Quickly adds a new wallet item to a wallet block (supports card, bank, crypto, remittance, link types). |
| POST api/wallet-blocks/{blockId}/items |
Adds a new wallet item with full details to a wallet block (card, bank, crypto, transfer, payment link). |
| PUT api/wallet-blocks/{blockId}/items/{id} |
Updates an existing wallet item with new details. |
| PUT api/wallet-blocks/{blockId}/items/sort |
Reorders wallet items within a block by updating their position indices. |
| DELETE api/wallet-blocks/{blockId}/items/{id} |
Permanently deletes a wallet item from a wallet block. |
Audio
| API | Description |
|---|
HeaderBlock
| API | Description |
|---|---|
| POST api/header-blocks/{blockId}/vcard |
Creates a new vCard profile associated with the specified header block. |
| PUT api/header-blocks/{blockId}/vcard |
Updates the existing vCard profile for the specified header block. |
| DELETE api/header-blocks/{blockId}/vcard |
Deletes the vCard associated with the specified header block. |
| GET api/header-blocks/{blockId}/vcard/download |
Downloads the vCard file (.vcf) associated with the specified header block. |
| PUT api/header-blocks/{blockId} |
Updates the main header content, bio, location, and layout settings. |
| PUT api/profiles/{profileId}/thoughts |
Updates the 'thought' or status message in the header block. |
| PUT api/header-blocks/{blockId}/fullname |
Updates the full name display settings in the header (font size, bold, custom image). |
| PUT api/header-blocks/{blockId}/name |
Updates the text for the user's name in the header. |
| PUT api/header-blocks/{blockId}/bio |
Updates the short bio description text in the header. |
| PUT api/header-blocks/{blockId}/profilepic/size |
Updates the pixel dimensions (width/height) of the profile picture. |
| PUT api/header-blocks/{blockId}/profilepic |
Updates the profile picture or video, potentially converting video to GIF if needed. |
| PUT api/header-blocks/{blockId}/cover |
Updates the cover image/video, height, and overlay text settings for the header. |
| PUT api/header-blocks/{blockId}/socials |
Updates the visual design of social icons (colors, borders, alignment, spacing). |
| POST api/header-blocks/{blockId}/buttons |
Adds a new functional button (CTA, Link, Subscribe) to the header. |
| POST api/header-blocks/{blockId}/subscribe/options |
Ensures default subscription platform options (Email, Telegram, Discord, etc.) exist for a block. |
| PUT api/header-blocks/{blockId}/subscribe/options/{id} |
Updates a specific subscription option (toggling visibility or verification requirements). |
| PUT api/header-blocks/{blockId}/buttons/{id} |
Updates an existing header button's appearance, label, and metadata. |
| DELETE api/header-blocks/{blockId}/buttons/{id}?type={type} |
Permanently removes a button from the header block. |
| PUT api/header-blocks/{blockId}/buttons/sort |
Updates the horizontal sorting order of buttons in the header. |
| PUT api/header-blocks/{blockId}/design/picture |
Updates the visual appearance of the profile picture (shapes, borders, shadows). |
| POST api/header-blocks/{blockId}/contacts |
Adds a new contact point (Phone, Email, WhatsApp, etc.) to the header block. |
| PUT api/header-blocks/{blockId}/contacts/{itemId} |
Updates an existing contact item's value or visibility settings. |
| PUT api/header-blocks/{blockId}/items/sort |
Updates the sorting order of contact items. |
| DELETE api/header-blocks/{blockId}/contacts/{itemId} |
Removes a contact item from the header block. |
| GET api/socials/enum |
Retrieves a list of available social links. |
| POST api/header-blocks/{blockId}/socials |
Adds a new social network link to the block. |
| PUT api/header-blocks/{blockId}/socials/{id} |
Updates an existing social link's URL or platform type. |
| PUT api/header-blocks/{blockId}/socials/sort |
Updates the horizontal sorting order of social links. |
| DELETE api/header-blocks/{blockId}/socials/{id} |
Permanently removes a social link from the block. |
VideoFeedbackBlock
| API | Description |
|---|
DataCollectBlock
| API | Description |
|---|---|
| PUT api/data-collect-blocks/{blockId} |
Updates the core header information (title, description, and image) and functional settings (terms, success message) of a data collection block. |
| PUT api/data-collect-blocks/{blockId}/design |
Updates the functional layout and orientation settings for the data collection form. |
| PUT api/data-collect-blocks/{blockId}/items |
Updates the set of enabled collection types (Email, Telegram, WhatsApp, etc.) for the block. |
| PUT api/data-collect-blocks/{blockId}/items/{itemId} |
Updates a specific collection method's placeholder, button text, or integration settings. |
| DELETE api/data-collect-blocks/{blockId}/items/{itemId} |
Permanently removes a specific input method (e.g., WhatsApp collection) from the form. |
| PUT api/data-collect-blocks/{blockId}/items/sort |
Updates the manual display order of input fields within the form. |
| PUT api/data-collect-blocks/{blockId}/items/{itemId}/active |
Toggles the active state of a specific input field. |
| POST api/data-collect-blocks/{blockId}/rewards |
Adds a reward (promo code or link) to be given to users upon successful data submission. |
| PUT api/data-collect-blocks/{blockId}/rewards/{rewardId} |
Updates the details of an existing reward. |
| DELETE api/data-collect-blocks/{blockId}/rewards/{rewardId} |
Permanently removes a reward configuration. |
| POST api/data-collect-blocks/{blockId}/rewards/attachments |
Attaches a downloadable file as a reward for users who complete the form. |
| DELETE api/data-collect-blocks/{blockId}/rewards/attachments/{fileId} |
Removes a specific file from the set of rewards. |
| POST api/data-collect-blocks/{blockId}/items/{itemId}/submit |
Processes a visitor's form submission, subscribes them, and returns any associated rewards. |
CrmCustomField
| API | Description |
|---|
TipBlock
| API | Description |
|---|---|
| PUT api/tip-blocks/{blockId} |
Updates an existing tip block within the system. |
| PUT api/tip-blocks/{blockId}/design |
Updates the design settings of a tip block. |
| POST api/profiles/{profileId}/tips/quick |
Quickly adds a new tip item to the specified profile. |
| POST api/profiles/{profileId}/tips |
Adds a new tip item to the specified profile. |
| PUT api/profiles/{profileId}/tips/{id}/settings |
Updates the settings of an existing tip item within a profile. |
| PUT api/profiles/{profileId}/tips/{id} |
Updates an existing tip item within a profile. |
| GET api/profiles/{profileId}/tips/{id} |
Retrieves a specific tip item within a given profile. |
| PUT api/tip-blocks/{blockId}/items/sort |
Sorts the tip items within a specified tip block. |
| DELETE api/profiles/{profileId}/tips/{id} |
Deletes a specific tip item from a given profile. |
| POST api/profiles/{profileId}/tips/{id}/amounts |
Adds a new tip amount option to a specific tip item. |
| PUT api/profiles/{profileId}/tips/{id}/amounts/{amountId} |
Updates an existing tip amount option for a specific tip item. |
| PUT api/profiles/{profileId}/tips/{id}/amounts/sort |
Sorts the tip amounts within a specific tip item. |
| DELETE api/profiles/{profileId}/tips/{id}/amounts/{amountId} |
Deletes a specific tip amount option from a tip item. |
| PUT api/profiles/{profileId}/tips/{itemId}/checkout/fields |
Updates the checkout fields for a specific tip item. |
| POST api/profiles/{profileId}/tips/checkout-session?id={id} |
Creates a Stripe checkout session for a tip order. |
| POST api/profiles/{profileId}/tips/{id}/submit |
Submits a new tip order for a given profile. |
Echo
| API | Description |
|---|
NftBlock
| API | Description |
|---|---|
| PUT api/nft-blocks/{blockId} |
Updates an existing NFT block with new data. |
| PUT api/nft-blocks/{blockId}/design |
Updates the design settings of an NFT block. |
| POST api/nft-blocks/{blockId}/items |
Adds a new NFT item to an NFT block. |
| DELETE api/nft-blocks/{blockId}/items/{id} |
Deletes an NFT item from an NFT block. |
Page
| API | Description |
|---|---|
| GET api/profiles/{username}/pages/{slug}/slug |
Retrieves a specific profile page configuration based on its friendly URL slug. |
| GET api/profiles/{profileId}/pages/{pageId} |
Retrieves the configuration for a specific page using its unique identifier. |
| PUT api/profiles/{profileId}/pages/{pageId}/slug |
Updates the URL slug for a specific page, handling reserved strings and ensuring uniqueness within the profile. |
| POST api/profiles/{profileId}/pages |
Registers a new page for a specific profile, auto-generating a unique slug and initializing default blocks. |
| PUT api/profiles/{profileId}/pages/{pageId}/active |
Toggles the published/active state of a specific profile page. |
| PUT api/profiles/{profileId}/pages/home |
Updates basic settings for the primary home page of a profile. |
| PUT api/profiles/{profileId}/pages/{pageId} |
Updates the core properties and design settings for an existing profile page. |
| PUT api/profiles/{profileId}/pages/{pageId}/settings |
Updates advanced page settings including SEO metadata, canonical URLs, and auto-slug behaviors. |
| PUT api/profiles/{profileId}/pages/{pageId}/duplicate |
Creates a complete copy of an existing page and its associated blocks. |
| PUT api/profiles/{profileId}/pages/sort |
Reorders the pages for a specific profile based on a provided sort list. |
| DELETE api/profiles/{profileId}/pages/{pageId} |
Permanently deletes a specific profile page and its associated blocks (if not reused elsewhere). |
Analytics
| API | Description |
|---|---|
| GET api/profiles/{profileId}/short-links/{id}/analytics?type={type}&period={period}&startDate={startDate}&endDate={endDate} |
Retrieves detailed analytics for a specific short link, including clicks, referrers, and geographic data. |
| GET api/profiles/{profileId}/analytics/old?type={type}&period={period}&startDate={startDate}&endDate={endDate} |
Retrieves analytics data using the legacy direct logs processing method. |
| GET api/profiles/{profileId}/analytics?type={type}&period={period}&startDate={startDate}&endDate={endDate} |
Retrieves optimized, aggregated analytics data for a specific profile using pre-processed daily statistics. |
| GET api/profiles/{profileId}/analytics/referrers?type={type}&period={period} |
Retrieves a breakdown of traffic referrers for the specified profile. |
| GET api/profiles/{profileId}/analytics/countries?type={type}&period={period} |
Retrieves a geographical breakdown of visitors by country for the specified profile. |
| GET api/profiles/{profileId}/analytics/charts?type={type}&period={period} |
Retrieves time-series data for a specific profile, suitable for generating analytics charts. |
| GET api/profiles/{profileId}/analytics/actions?type={type}&period={period} |
Retrieves analytics on specific visitor actions (e.g., button clicks, link follows) for a profile. |
| PUT api/profiles/{profileId}/analytics/clean |
Clears all historical analytics data for a profile, including logs and aggregated stats. |
FooterBlock
| API | Description |
|---|---|
| POST api/footer-blocks/{blockId}/items |
Adds a new element (social, payments, etc.) to the footer block. |
| PUT api/footer-blocks/{blockId}/items/sort |
Updates the sorting order of elements within the footer block. |
| DELETE api/footer-blocks/{blockId}/items/{id} |
Permanently removes an element from the footer block. |
Stats
| API | Description |
|---|---|
| GET api/profiles/{profileId}/stats?period={period} |
Retrieves preview statistics for a user profile within a specified time period. This endpoint provides visitor insights, including total visits, unique visitors, and actions performed. |
| POST api/profiles/{profileId}/stats/reset |
Resets the preview statistics for a specific profile. This function updates the last reset timestamp, effectively clearing previous statistics. |
PublicStickerPacks
| API | Description |
|---|
WorkoutBlock
| API | Description |
|---|
UserAgentRunOutcome
| API | Description |
|---|
GoogleBusiness
| API | Description |
|---|
UserAgentTeam
| API | Description |
|---|
NotifySubscribers
| API | Description |
|---|---|
| POST api/profiles/{profileId}/notify |
Sends automated notifications to profile subscribers (via Telegram, Discord, etc.) when new content like blog posts or articles are published. |
WelcomeBlock
| API | Description |
|---|---|
| PUT api/welcome-blocks/{blockId} |
Updates an existing welcome message block with delay, frequency, and message content. |
DesignSystem
| API | Description |
|---|
Discover
| API | Description |
|---|
FileBlock
| API | Description |
|---|---|
| POST api/file-blocks/{blockId}/items |
Adds a new file item to a block. |
| PUT api/file-blocks/{blockId}/items/{id} |
Updates an existing file item's metadata and access settings. |
| PUT api/file-blocks/{blockId}/items/sort |
Updates the sorting order of file items within a block. |
| DELETE api/file-blocks/{blockId}/items/{id} |
Permanently deletes a file item from its block. |
SpacerBlock
| API | Description |
|---|---|
| PUT api/spacer-blocks/{blockId} |
Updates an existing spacer block with new data. |
PromobarBlock
| API | Description |
|---|---|
| PUT api/promo-blocks/{blockId} |
Updates the properties of a promotional bar block. |
| PUT api/promo-blocks/{blockId}/design |
Updates the design settings of a promobar block. |
| PUT api/promo-blocks/{blockId}/settings |
Updates the settings of a promobar block. |
Product
| API | Description |
|---|---|
| POST api/profiles/{profileId}/products/{productId}/messages |
Sends an anonymous message or inquiry regarding a specific product from a profile guest. |
| PUT api/profiles/{profileId}/store/tab |
Toggles the activation state of the store tab on a profile. |
| PUT api/profiles/{profileId}/store/last |
Updates whether the most recent store products are displayed as a preview list on the profile. |
| PUT api/profiles/{profileId}/store/design |
Updates the visual layout (e.g., 'grid', 'list') of the product store on a profile. |
| POST api/profiles/{profileId}/products |
Adds a new product to a profile from an external URL, a template, or as a completely new custom item. |
| GET api/profiles/{profileId}/products/search?take={take}&skip={skip}&q={q} |
Searches for products within a profile based on a text query. |
| GET api/profiles/{profileId}/products/{productId} |
Retrieves the detailed configuration for a specific product using its primary ID. |
| GET api/profiles/{username}/products/{slug}/slug |
Retrieves the detailed configuration and localized metadata for a product by its URL slug. |
| PUT api/profiles/{profileId}/products/{productId}/slug |
Updates the URL slug for a specific product, ensuring it is unique and follows standard slug formatting. |
| PUT api/profiles/{profileId}/products/{productId}/status |
Toggles the active/inactive state of a specific product on a profile. |
| DELETE api/profiles/{profileId}/products/{productId} |
Permanently deletes a product from a profile and clears associated caches. |
| POST api/profiles/{profileId}/products/{itemId}/automation |
Saves Instagram DM automation settings for a product. |
| PUT api/profiles/{profileId}/products/{itemId}/automation/{id} |
Updates the Instagram Direct Message automation configuration for a specific product item. |
| PUT api/profiles/{profileId}/products/{itemId}/automation/{id}/active |
Toggles the activation state of Instagram DM automation for a specific product item. |
| DELETE api/profiles/{profileId}/products/{itemId}/automation/{id} |
Permanently removes an Instagram DM automation configuration. |
| POST api/profiles/{profileId}/products/import |
Processes a CSV file upload to bulk import product data into a specific profile and block. |
| POST api/profiles/{profileId}/products/{productId}/media |
Attaches a new media file (image or video) to a product's gallery. |
| PUT api/profiles/{profileId}/products/{productId}/media/sort |
Updates the display sequence of media items in a product's gallery. |
| DELETE api/profiles/{profileId}/products/{productId}/media/{mediaId} |
Permanently removes a media file from a product's gallery. |
| POST api/profiles/{profileId}/products/{productId}/labels |
Associates a global label (e.g., 'New', 'Sale', 'Hot') with a specific product. |
| DELETE api/profiles/{profileId}/products/{itemId}/labels/{labelId} |
Removes a label association from a product. |
| POST api/profiles/{profileId}/products/{productId}/attachments |
Attaches a downloadable file or resource to a product, providing specific titles and optional expiration dates. |
| PUT api/profiles/{profileId}/products/{productId}/attachments/{attachmentId} |
Updates the metadata, description, or activation status of a product attachment. |
| PUT api/profiles/{profileId}/products/{productId}/attachments/sort |
Updates the sort order of multiple attachments for a specific product. |
| DELETE api/profiles/{profileId}/products/{productId}/attachments/{attachmentId} |
Permanently removes an attachment resource from a product. |
| POST api/profiles/{profileId}/products/{productId}/reviews |
Adds a review to a product. |
| PUT api/profiles/{profileId}/products/{productId}/reviews/{reviewId} |
Updates the content, rating, and customer details of an existing product review. |
| PUT api/profiles/{profileId}/products/{productId}/reviews/sort |
Updates the display sequence of reviews for a specific product. |
| DELETE api/profiles/{profileId}/products/{productId}/reviews/{reviewId} |
Permanently removes a review from a specific product. |
| POST api/profiles/{profileId}/labels |
Creates a new global label for a profile that can be subsequently attached to products. |
| PUT api/profiles/{profileId}/labels/{labelId} |
Updates the text or color of an existing profile label. |
| PUT api/profiles/{profileId}/labels |
Synchronizes the complete list of labels for a profile, adding new ones, updating existing ones, and deleting those omitted from the list. |
| DELETE api/profiles/{profileId}/labels/{labelId} |
Permanently removes a label from a profile and detaches it from all associated products. |
| GET api/profiles/{profileId}/labels |
Retrieves all custom product labels defined for a specific profile. |
Music
| API | Description |
|---|---|
| PUT api/profiles/{profileId}/music/{id} |
Updates the metadata and configuration for an existing music item (track, album, or playlist). |
| GET api/profiles/{profileId}/music?take={take}&skip={skip} |
Retrieves a paginated list of music items associated with a specific profile. |
| DELETE api/profiles/{profileId}/music/{id} |
Permanently removes a music item from a profile. |
MyTemplates
| API | Description |
|---|
StatusBlock
| API | Description |
|---|
AiClip
| API | Description |
|---|
AbTest
| API | Description |
|---|
EmbedForm
| API | Description |
|---|
Feed
| API | Description |
|---|
LiveChatPublic
| API | Description |
|---|
Growth
| API | Description |
|---|
YouTube
| API | Description |
|---|---|
| GET api/profiles/{profileId}/youtube/connect |
Connects a YouTube account to a profile by initiating OAuth authorization flow. |
MuxWebhook
| API | Description |
|---|
TextBlock
| API | Description |
|---|
ListingBlock
| API | Description |
|---|---|
| PUT api/listing-blocks/{blockId} |
Updates an existing listing block with new data. |
| PUT api/listing-blocks/{blockId}/design |
Updates the block design settings (view, layout) of a listing block. |
| POST api/listing-blocks/{blockId}/items |
Adds a new item to the specified listing block. |
| PUT api/listing-blocks/{blockId}/items/{id} |
Updates an existing item in the specified listing block. |
| GET api/listing-blocks/{blockId}/items/{id} |
Retrieves a specific item with extended information (media, properties, sections) from the specified listing block. |
| DELETE api/listing-blocks/{blockId}/items/{id} |
Deletes a specific item from the specified listing block. |
| PUT api/listing-blocks/{blockId}/items/sort |
Updates the order of items within the specified listing block. |
| POST api/listing-blocks/{blockId}/items/{itemId}/media |
Adds a new media item to a specific listing item within the listing block. |
| PUT api/listing-blocks/{blockId}/items/{itemId}/media/{mediaId} |
Updates an existing media item of a specific listing item within the listing block. |
| DELETE api/listing-blocks/{blockId}/items/{itemId}/media/{mediaId} |
Deletes a specific media item from a listing item within the listing block. |
| PUT api/listing-blocks/{blockId}/items/{itemId}/media/sort |
Updates the order of media items within a specific listing item of the listing block. |
| POST api/listing-blocks/{blockId}/items/{itemId}/properties |
Adds a new property to a specific listing item within the listing block. |
| PUT api/listing-blocks/{blockId}/items/{itemId}/properties/{propId} |
Updates an existing property of a specific listing item within the listing block. |
| DELETE api/listing-blocks/{blockId}/items/{itemId}/properties/{propId} |
Deletes a specific property from a listing item within the listing block. |
| POST api/listing-blocks/{blockId}/items/{itemId}/sections |
Adds a new section (e.g., text, HTML) to a specific listing item within the listing block. |
| PUT api/listing-blocks/{blockId}/items/{itemId}/sections/{sectionId} |
Updates a specific section of a listing item within the listing block. |
| DELETE api/listing-blocks/{blockId}/items/{itemId}/sections/{sectionId} |
Deletes a specific section from a listing item within the listing block. |
| PUT api/listing-blocks/{blockId}/items/{itemId}/sections/sort |
Updates the order of sections within a specific listing item of the listing block. |
Upsell
| API | Description |
|---|
Blog
| API | Description |
|---|---|
| PUT api/profiles/{profileId}/blogs/tab |
Updates the blog tab visibility/active status for a specific profile. |
AdminNewsroom
| API | Description |
|---|
CouponBlock
| API | Description |
|---|---|
| PUT api/coupon-blocks/{blockId} |
Updates a coupon block's general settings and heading content. |
| PUT api/coupon-blocks/{blockId}/design |
Updates the visual layout and display mode for the coupon block. |
| POST api/profiles/{profileId}/coupons |
Creates a new coupon and attaches it to the specified profile. |
| PUT api/profiles/{profileId}/coupons/{itemId} |
Updates an existing coupon's details (code, value, description) and its internal design settings. |
| GET api/profiles/{profileId}/coupons/{itemId} |
Retrieves full information for a specific coupon item. |
| PUT api/coupon-blocks/{blockId}/items/sort |
Updates the manual display order of coupons within the block. |
| DELETE api/profiles/{profileId}/coupons/{itemId} |
Permanently deletes a specific coupon from the profile. |
| PUT api/profiles/{profileId}/coupons/{itemId}/checkout/fields |
Configures which customer information (name, phone, etc.) is required to claim the coupon. |
| POST api/profiles/{profileId}/coupons/{itemId}/submit |
Processes a coupon claim/purchase request with submitted customer details. |
CrmPipeline
| API | Description |
|---|
TeamBlock
| API | Description |
|---|---|
| PUT api/team-blocks/{blockId} |
Updates a team block with new heading details. |
| PUT api/team-blocks/{blockId}/design |
Updates the design layout of a team block. |
| PUT api/team-blocks/{blockId}/items/sort |
Sorts the team items within a specific team block. |
| POST api/team-blocks/{blockId}/items |
Adds a new team item to a specific team block. |
| PUT api/team-blocks/{blockId}/items/{id} |
Updates an existing team item in a specific team block. |
| DELETE api/team-blocks/{blockId}/items/{id} |
Deletes a team item from a team block. |
TrendingPosts
| API | Description |
|---|
Calendly
| API | Description |
|---|
BumpOffer
| API | Description |
|---|
Sdk
| API | Description |
|---|
ShopBlock
| API | Description |
|---|---|
| DELETE api/profiles/{profileId}/shops/categories/{categoryId} |
Permanently removes a category from the profile. |
| GET api/profiles/{profileId}/shops/categories |
Implementation of GET for retrieving all categories defined in a profile. |
| POST api/profiles/{profileId}/shops/{productId}/categories/{categoryId} |
Links a product to one of the defined categories. |
| DELETE api/profiles/{profileId}/shops/{productId}/categories/{categoryId} |
Removes a category association from a product. |
| GET api/carts?cookie={cookie}&profileId={profileId} |
Locates or initializes a shopping cart for a specific visitor identified by a cookie. |
| POST api/carts/items |
Adds a product to the cart or increments its quantity if it's already present. |
| PUT api/profiles/{profileId}/shops/{productId}/checkout/fields |
Configures which data fields (Name, Email, Address, etc.) are shown and required during checkout for a specific product. |
| POST api/profiles/{profileId}/shops/{productId}/preorder/submit |
Submits a preorder request for a product that is not currently in stock or available for direct purchase. |
| POST api/products/{productId}/preorder/submit |
Submits a preorder request for a product that is not currently in stock or available for direct purchase. |
| POST api/carts/{id}/submit |
Finalizes a shop purchase by converting a cart into a formal order with customer and shipping data. |
| PUT api/profiles/{profileId}/shops/preorder |
Updates the visibility and requirement settings for the global preorder form template in a profile. |
| PUT api/shop-blocks/{blockId} |
Updates the core information of a shop block. |
| PUT api/shop-blocks/{blockId}/design |
Updates the layout and visual style of the shop block. |
| PUT api/shop-blocks/{blockId}/design/category |
Updates the visual design and layout for product category filters. |
| PUT api/shop-blocks/{blockId}/settings |
Updates functional shop settings. |
| POST api/profiles/{profileId}/shops |
Initial creation of a shop product with default parameters. |
| PUT api/profiles/{profileId}/shops/{productId} |
Comprehensive update of a shop product's data, pricing, attributes, and tags. |
| PUT api/profiles/{profileId}/shops/{productId}/status |
Toggles a product's active status (visibility in the shop). |
| PUT api/shop-blocks/{blockId}/items/sort |
Updates the manual sorting order of products within a specific block. |
| GET api/profiles/{profileId}/shops/{productId} |
Returns full details for a specific shop product, including branding and currency info. |
| PUT api/profiles/{profileId}/shops/{productId}/seo |
Updates the SEO metadata (titles, descriptions, canonical URLs) for a product. |
| GET api/profiles/{profileId}/shops/{productId}/similar |
Suggests products similar to the current one based on hashtags or randomization. |
| POST api/profiles/{profileId}/shops/{productId}/duplicate |
Creates a complete copy of an existing product, including its media, labels, and properties. |
| DELETE api/profiles/{profileId}/shops/{productId}/actions |
Clears all interactive buttons and external links from a product. |
| DELETE api/profiles/{profileId}/shops/{productId} |
Permanently removes a product and all its assets from the shop. |
| POST api/profiles/{profileId}/shops/{productId}/media |
Uploads or links new media (image/video) to an existing product. |
| DELETE api/profiles/{profileId}/shops/{productId}/media/{mediaId} |
Removes a specific media file from a product's gallery. |
| POST api/profiles/{profileId}/shops/{productId}/labels |
Attaches a predefined label (e.g., 'NEW', 'SALE') to a product. |
| DELETE api/profiles/{profileId}/shops/{productId}/labels/{labelId} |
Detaches a specific label from a product. |
| POST api/profiles/{profileId}/shops/{productId}/reviews |
Submits a new customer review for a shop product. |
| PUT api/profiles/{profileId}/shops/{productId}/reviews/{reviewId} |
Updates the content or rating of an existing product review. |
| PUT api/profiles/{profileId}/shops/{productId}/reviews/sort |
Reorders how reviews are displayed for a specific product. |
| DELETE api/profiles/{profileId}/shops/{productId}/reviews/{reviewId} |
Permanently removes a review from a product. |
| PUT api/profiles/{profileId}/shops/{productId}/tags/{tagId} |
Modifies an interactive tag on a product image/video (position, target URL, price). |
| DELETE api/profiles/{profileId}/shops/{productId}/tags/{tagId} |
Detaches an interactive tag from its associated product media. |
| POST api/profiles/{profileId}/shops/items/{productId}/likes |
Registers a 'like' action from a visitor for a specific shop product. |
| POST api/profiles/{profileId}/shops/properties |
Defines new custom properties (e.g., Color, Size) for shop products. |
| PUT api/profiles/{profileId}/shops/properties/{propertyId} |
Updates a property definition, including adding or removing potential values. |
| DELETE api/profiles/{profileId}/shops/properties/{propertyId} |
Permanently deletes a global property definition from the profile's store. |
| POST api/profiles/{profileId}/shops/lists |
Creates a new organized list/collection for grouping products. |
| PUT api/profiles/{profileId}/shops/lists/{listId} |
Updates the title of an existing shop collection list. |
| PUT api/profiles/{profileId}/shops/lists |
Syncs multiple shop lists, adding new ones and removing those not present in the model. |
| PUT api/profiles/{profileId}/shops/lists/sort |
Updates the display order of product collection lists. |
| DELETE api/profiles/{profileId}/shops/lists/{listId} |
Deletes a shop list. Note: Products inside are not deleted but are removed from this list. |
| POST api/profiles/{profileId}/shops/{productId}/lists/{listId} |
Assigns a product to a specific collection list. |
| DELETE api/profiles/{profileId}/shops/{productId}/lists/{listId} |
Removes a product from a collection list. |
| POST api/profiles/{profileId}/shops/categories |
Creates a new product category for organization and filtering. |
| PUT api/profiles/{profileId}/shops/categories/{categoryId} |
Updates an existing category's metadata (title or cover image). |
| PUT api/profiles/{profileId}/shops/categories |
Batch updates or adds categories for a specific profile. |
| PUT api/profiles/{profileId}/shops/categories/sort |
Updates the manual display order of categories. |
TrackingCampaign
| API | Description |
|---|