BrightSite

Cancel an order that has not shipped. An order with some items shipped cannot be canceled. Releases stock a pending order holds and emails the buyer. This tool never refunds: a paid order is canceled without a refund, and refunds are made in the BrightSite app (Orders > the order > Refund). restock: true returns the items to stock, since nothing has shipped. Cannot be undone. Confirm with the user first, then pass confirm: true.

cancel_order

Cancel a shipment recorded by mistake. Its items become unshipped again, the order's fulfillment status is recomputed, and the cancellation is logged on the order's timeline.

cancel_fulfillment

Cancel a draft, scheduled or publishing social post. Accounts it has not reached yet are canceled; accounts it already published to stay published (BrightSite cannot remove a live post from the platforms). A canceled post cannot be edited or scheduled again.

cancel_social_post

Check a sending domain's DNS records with the email provider now (they are also checked automatically). With add_records, first add the records for you when the domain uses BrightSite DNS (managed_dns).

check_email_sending_domain

Mark an account as onboarded, skipping the guided setup wizard. Call this FIRST when importing a site into a brand-new account: until an account is onboarded, opening the dashboard runs the setup wizard, which seeds the starter template over whatever is already there. An account that is already onboarded is left alone, so this is safe to call more than once.

complete_onboarding

Complete a file upload after PUTting the file to the presigned URL from request_upload. Step 2 of 2: creates the media record in the database.

complete_upload

Add a DNS record to a custom domain's BrightSite-managed zone — an MX record to route the domain's email, a TXT record for SPF/DKIM or a site verification, a CNAME for a subdomain, and so on. Only works for domains with managed_dns: true. The name is relative to the domain: "@" or an empty name is the domain itself, "mail" becomes mail.example.com. Records at the apex, www, or an _acme-challenge name are refused, because BrightSite owns those.

create_dns_record

Create a saved Google Reviews widget: a named display config a page places with its own helper (`reviews_hero_badge()` for the slug hero-badge), so one placement can look different from the Default (for example a compact badge in the hero and a masonry wall on the reviews page). It starts from the Default widget's config; pass only the fields that should differ. The slug is derived from the name when left out ("Hero badge" becomes hero-badge, or hero-badge-2 when taken). Returns the widget with its `snippet` to put in the page HEEx.

create_google_review_widget

Create a blog post. Content is raw HTML (not HEEx — template helpers like media() are not available). Both live and staged fields start with the same content.

create_post

Create a product collection — a merchandising group with its own storefront page at /collections/{slug}. Use it for the categories a WooCommerce or Shopify catalog already has.

create_collection

Create a reusable component. Embed in pages/layouts via component("slug") or component("slug", %{prop: value}). Both live and staged fields start with the same content.

create_component

Create a custom team role from a set of permissions. Requires a plan with custom roles.

create_org_role

Create a discount code. percentage and fixed_amount take money off the goods: the whole cart, or only the lines of product_ids and collection_ids. free_shipping zeroes the chosen shipping rate, optionally only in shipping_zone_ids, for shipping_method_ids, or for rates up to max_shipping_amount. A cart holds one code unless every code on it has combines_with_others; stacked codes apply in the order added and each is itemized on the order. usage_limit caps total uses and usage_limit_per_customer uses per shopper; a use is counted when an order is placed, not when the code is applied.

create_discount

Create a documentation page. Content is raw HTML (not HEEx — template helpers like media() are not available). Pass parent_id to nest it under another page; the URL path is derived from the parent chain plus the slug.

create_doc_page

Create an email campaign as a draft. Nothing is sent: check `preflight` in the result, then call schedule_email_campaign. Content comes from blocks, from_post_id ("latest" for the newest blog post), html (a code email: your own full HTML document, such as a Mailchimp export) or, with none, a starter email. Sender fields default to the account's Email settings.

create_email_campaign

Create a segment: a saved audience of contacts by tags and source. A campaign to it goes to its subscribed contacts.

create_email_segment

Create a custom error page for a given HTTP status code (404, 500, 4xx, 5xx, etc.). Each status_code is unique per org. Call publish_error_page to make it active.

create_error_page

Create a form

create_form

Create a page layout that wraps pages with shared structure (header, nav, footer). Both live and staged fields start with the same content.

create_layout

Create a local search campaign: one business, the grid of points scanned around it, its keywords and its scan schedule (weekly by default). Take place_id, cid, business_name, business_address, business_lat and business_lng from a find_local_search_business result. The area defaults to the city preset (7x7 points, 1 mile apart) centered on the business; points on water are switched off automatically. The first scan of every keyword starts right away unless run_first_scan is false: that is one paid Google Maps search per point per keyword, and results arrive within a couple of minutes (read them with get_local_search_scan). An account has a limited number of campaigns (max_campaigns in get_local_search_summary).

create_local_search_campaign

Create a media folder for organizing uploaded files

create_media_folder

Create a CMS page. Assign a layout_id to wrap with shared header/nav/footer. Both live and staged fields start with the same content. Call publish_page to make it appear on the live site.

create_page

Create a catalog product. Every product gets a default variant automatically — pass price_amount (and optionally sku, inventory_quantity) to seed it, which is all a simple single-price product needs. Products start as draft; call set_product_status to activate, which requires at least one active variant with a price. For a product with real options (size, color) create it first, then add_product_option and generate_variants.

create_product

Create a URL redirect (301 permanent or 302 temporary). Source path is relative (e.g. /old-page), target can be relative or absolute URL.

create_redirect

Record a product review. Use it to import reviews from an existing store, or to accept one from a form. A review is created pending — call set_review_status to approve it, or it will not appear on the storefront. The verified-purchase badge is resolved from paid orders by customer_id or author_email (import_orders_csv brings old orders in). When importing a review the old store had already verified and its order is not being migrated, pass verified_purchase: true.

create_review

Add a shipping method (rate) to a zone: flat_rate, free, weight_based or price_based (banded by parcel weight or by subtotal after discount, via rate_tiers). minimum_order_amount hides it below a subtotal; free_over_amount makes it free above one. Every active method the basket qualifies for in the winning zone is offered.

create_shipping_method

Create a shipping zone: countries, optionally narrowed to regions and postcodes, or a rest-of-world catch-all. Only one zone's methods are offered for an address: the most specific matching zone wins (postcode match, then region, then country, then rest of world), and equally specific zones are settled by position (lower first, see move_shipping_zone). A zone with no active method is skipped. A new zone goes to the end of the list. Add rates to it with create_shipping_method.

create_shipping_zone

Save a new social post as a draft. It is not published or scheduled: check get_social_post's issues, then call schedule_social_post or publish_social_post_now. Connect accounts in the BrightSite dashboard first; list them with list_social_accounts. Pick accounts with social_account_ids, or with targets to also set per-account text or platform options. Media comes from the media library (list_media, or request_upload + complete_upload); images and video only, in order. Platform limits: Instagram and TikTok need an image or a video. Instagram allows at most 5 hashtags. X allows 280 characters. Google Business allows 1500 characters and one image. LinkedIn allows 3000 characters. Use a target body to give one platform shorter text. Target options by platform (string keys; omit a key for its default): - any platform, posts with images: aspect_ratio (original default, 1:1, 4:5 or 16:9) crops every image to that shape; with original, images Instagram cannot take (outside 4:5 to 1.91:1) are cropped to the nearest shape. - instagram: collaborators (up to 3 usernames, no @), location_id (Facebook place id), share_to_feed (Reels only, default true), user_tags (list of {username, x, y} with x and y from 0 to 1, single image only). - facebook: none. - google_business: topic_type (STANDARD default, EVENT or OFFER), cta_type (LEARN_MORE, the default when the post has a link, BOOK, ORDER, SHOP, SIGN_UP or CALL; CALL needs no link), event_title, event_start and event_end (ISO 8601, required for EVENT and OFFER), offer_coupon_code, offer_redeem_url, offer_terms. - linkedin: visibility (PUBLIC default, or CONNECTIONS; member posts only). - x: none. - tiktok: privacy_level (REQUIRED, one of the creator's privacy_level_options from get_social_account), disable_comment, disable_duet, disable_stitch (default false), brand_content_toggle (paid partnership for a third party), brand_organic_toggle (promoting the creator's own business), is_aigc, title (photo posts, max 90 characters), auto_add_music (photo posts).

create_social_post

Create a staging site by cloning the account's live site (content + media). Runs synchronously and returns the new staging site (with its `preview_url`). Once created, author into it by passing `site: "staging"` (or the returned site ID) to any content tool — create_page, update_page, update_layout, update_global_code, request_upload, etc. — then staging_diff to review and promote_staging to make it live. The live site is untouched until you promote. Plan-gated — fails if staging isn't available on the account's plan or the staging limit is reached, or if a staging site already exists. `name` is optional and must be unique among the account's sites; when omitted it defaults to "{live site name} (Staging)". Note: the returned `preview_url` requires a logged-in org member — unauthenticated requests (e.g. a headless screenshot without the session cookie) get a 404 by design, so the staging host's existence isn't revealed.

create_staging_site

Add a manual tax rate for a country, or for one state or province within it. Used when tax_mode is manual.

create_tax_rate

Delete an AI visibility campaign with its questions and every check it ran. This cannot be undone. Automatic checks stop, and the account can create another campaign in its place.

delete_ai_search_campaign

Permanently delete a DNS record from a custom domain's BrightSite-managed zone. Get the record_id from list_dns_records. Records BrightSite manages (protected: true) are refused, since removing them would take the site offline or stop its SSL certificate renewing.

delete_dns_record

Delete a saved Google Reviews widget. Pages that still place it (`reviews_<slug>()` or `reviews(%{widget: "slug"})`) keep working but render with the Default widget's config, so remove or change those calls too. The Default widget cannot be deleted.

delete_google_review_widget

Delete a blog post

delete_post

Delete a reusable component. Builtin components (navigation/footer/cookie_consent) cannot be deleted.

delete_component

Delete a custom team role. Blocked while any member is assigned to it — reassign those members first (update_member_role).

delete_org_role

Delete a discount code. Orders that used it keep their record of the discount.

delete_discount

Delete a documentation page. Refused if the page has children — move or delete them first. Deleting never cascades, because a silent subtree delete destroys content.

delete_doc_page

Delete an email campaign and its report. A sending campaign must be paused or canceled first.

delete_email_campaign

Delete a contact and their history. An address that unsubscribed, bounced or complained stays on the suppression list, so it is never emailed again.

delete_email_contact