API reference

https://api.hypamoon.com/api/v1

{
  "domain": "example.com",
  "site_id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f"
}

{
  "domain": "example.com",
  "expected_hosts": [
    "netlify"
  ],
  "park": "page"
}

{
  "include_record_ids": [
    "372e67954025e0ba6aaa6d586b9e0b59"
  ]
}

{
  "cleanup_id": "0b6f0e0e-2a7c-4d39-9a8e-1d3c5b7a9e21"
}

{
  "domain": "example.nl",
  "years": 1,
  "accept_registry_terms": true,
  "max_price_eur": 7.32
}

{
  "hsts": "on"
}

{
  "site_id": "6f1c2d3e-4b5a-4c7d-8e9f-0a1b2c3d4e5f"
}

{
  "type": "TXT",
  "name": "@",
  "content": "google-site-verification=abc123"
}

{
  "confirm": true
}

{
  "zone_file": "$ORIGIN example.com.\n@ 3600 IN MX 10 mail.example.com.\n@ 3600 IN TXT \"v=spf1 include:_spf.example.net ~all\"\n",
  "replace_existing": false
}

{}

{
  "use": "hypamoon"
}

{
  "domain": "example.nl",
  "authcode": "AbC123xyz!",
  "accept_registry_terms": true,
  "max_price_eur": 7.32,
  "dns": "hypamoon"
}

{
  "id": "7d4e2b10-3c5a-4f6e-9b8d-1a2b3c4d5e6f",
  "name": "Acme Plumbing",
  "edition": "api",
  "created_at": "2026-10-01T09:00:00.000Z",
  "spending_limit_eur": 100,
  "numbers_count": 0,
  "mode": "live",
  "rails": {
    "phone": "live",
    "outbound": "live",
    "sms": "live",
    "email": "live",
    "payments": "live",
    "domains": "test"
  },
  "verification": {
    "account_type": "business",
    "levels": [
      {
        "level": "test",
        "status": "approved",
        "reason": null,
        "missing": [],
        "unlocks": [
          "test_keys",
          "test_numbers",
          "simulated_calls"
        ]
      },
      {
        "level": "company",
        "status": "not_started",
        "reason": null,
        "missing": [
          "payment_mandate",
          "payment_authentication",
          "phone_verification"
        ],
        "unlocks": [
          "live_keys",
          "national_numbers",
          "inbound_calls"
        ]
      },
      {
        "level": "number_documents",
        "status": "not_started",
        "reason": null,
        "missing": [
          "level.company",
          "document.proof_of_address",
          "document.identity",
          "document.company_registration"
        ],
        "unlocks": [
          "geographic_numbers"
        ]
      },
      {
        "level": "full",
        "status": "not_started",
        "reason": null,
        "missing": [
          "level.company",
          "director_identity",
          "ubo_confirmation",
          "review"
        ],
        "unlocks": [
          "outbound_calls",
          "spending_cap_above_500_eur",
          "more_concurrent_calls"
        ]
      }
    ]
  },
  "access": null
}

{
  "company_name": "Acme Plumbing Ltd",
  "registration_number": "01234567",
  "address": {
    "street": "Main Street",
    "house_number": "40",
    "postal_code": "SW1A 1AA",
    "city": "London",
    "country": "GB"
  },
  "contact": {
    "name": "Jane Smith",
    "phone": "+447700900123"
  }
}

{
  "account_type": "business",
  "company_name": "Acme Plumbing Ltd",
  "kvk_number": null,
  "registration_number": "01234567",
  "vat_number": null,
  "vat_status": "not_required",
  "vat_checked_at": null,
  "address": {
    "street": "Main Street",
    "house_number": "40",
    "postal_code": "SW1A 1AA",
    "city": "London",
    "country": "GB"
  },
  "contact": {
    "name": "Jane Smith",
    "phone": "+447700900123"
  },
  "registrar_contact_name": null,
  "complete": true
}

{
  "type": "webshop",
  "title": "Webshop",
  "summary": "A shop on the user's own site: products, a real checkout (or an honest order request while payments are not on), order emails and the pages a shop needs to go live.",
  "country": "NL",
  "region": "eu",
  "audience": "consumers",
  "how_to_use": "This is for you, the agent, to inform yourself; it is not a questionnaire for the user. Ask only the questions marked blocking (at most two or three), in plain words, and only if the user has not answered them already. For everything else use the default and mention briefly which defaults you used. If the user says \"just build it\" or skips a question, use the defaults and build. Follow build_plan with the real tools. Offer the go-live checklist afterwards as an option (\"Want me to go through what you might want to arrange before going live?\"), never as a condition for building or deploying. Name collections and their fields, and an app's tables and columns, in English and snake_case, descriptive (job_applications, contact_messages, full_name); the content and the texts on the site stay in the site's language.",
  "ask_first": [
    {
      "id": "country",
      "question": "Which country is your business in, and where do you sell to?",
      "why": "It decides the rules (returns, VAT, what the site must show), the currency and the language.",
      "default": "The Netherlands, selling within the Netherlands, in euro and Dutch.",
      "blocking": true
    },
    {
      "id": "products",
      "question": "What do you sell, and roughly how many products? Do they come in variants like size or color?",
      "why": "It decides how the product list is built and whether every variant needs its own price and stock.",
      "default": "A small catalogue (up to 20 products) without variants; each variant would be its own product.",
      "blocking": true
    },
    {
      "id": "seller",
      "question": "Do you sell as a business or as a private person, and to consumers or to other businesses?",
      "why": "Consumer rules (14 days to withdraw, prices with VAT) apply when a business sells to consumers.",
      "default": "A business selling to consumers.",
      "blocking": false
    },
    {
      "id": "shipping",
      "question": "How do you ship, and what does shipping cost?",
      "why": "Shipping costs must be clear before the customer orders.",
      "default": "One flat shipping rate within the country, shown on every product page and before checkout; pickup on request.",
      "blocking": false
    },
    {
      "id": "returns",
      "question": "How do you handle returns?",
      "why": "Consumers in the EU and UK can usually withdraw within 14 days; the site has to explain how.",
      "default": "The legal minimum: 14 days to withdraw, the customer pays return shipping, refund within 14 days.",
      "blocking": false
    },
    {
      "id": "stock",
      "question": "Do you want the shop to track stock?",
      "why": "With stock tracking a product goes off sale when it runs out.",
      "default": "No stock tracking (unlimited); the owner takes a product off sale by hand.",
      "blocking": false
    },
    {
      "id": "payment_methods",
      "question": "Which payment methods do you want to offer?",
      "why": "Buyers expect their usual method (iDEAL in the Netherlands, cards elsewhere).",
      "default": "What the user's own payment account offers (in the Netherlands usually iDEAL and cards).",
      "blocking": false
    },
    {
      "id": "order_emails",
      "question": "Who should receive the order emails?",
      "why": "Someone has to see every order and ship it.",
      "default": "The project's billing email address.",
      "blocking": false
    },
    {
      "id": "language_currency",
      "question": "Which language and currency should the shop use?",
      "why": "Prices and texts must match where the customers are.",
      "default": "The language and currency of the user's country.",
      "blocking": false
    }
  ],
  "build_plan": [
    {
      "id": "pages",
      "title": "Pages first",
      "how": "deploy_site with a home page, a product list, a product page per product (or one page with all products), /contact with the company details, /terms, /privacy, /returns with the withdrawal form, and /404.html. Use the user's real texts and prices; leave out what they do not have yet.",
      "tools": [
        "deploy_site"
      ]
    },
    {
      "id": "products",
      "title": "Products as data",
      "how": "With payments available: create_product_collection, then insert_document per product (name, price_cents including VAT, optional stock). Without payments: create_collection \"products\" with access {\"public_read\": true} and insert_document per product, so the site and the assistant read the same list.",
      "tools": [
        "create_product_collection",
        "create_collection",
        "insert_document"
      ]
    },
    {
      "id": "checkout",
      "title": "A real checkout, or an honest order request",
      "how": "Call get_payments_status: when ready is true, get_checkout_snippet per product and put the buy button on the product page. When the payment account is not connected yet, connect_payments gives the owner the link. When payments are not available (no such tool, or the user does not want them yet): build an order request instead. create_collection \"order_requests\" with access {\"public_write\": true} and triggers {\"email_on_insert\": true}, get_form_snippet, and a button that says \"Send order request\". The page says plainly that the shop confirms availability and sends payment details, and that nothing is paid yet. Never a \"Pay now\" button that does not take a payment.",
      "tools": [
        "get_payments_status",
        "connect_payments",
        "get_checkout_snippet",
        "create_collection",
        "get_form_snippet"
      ]
    },
    {
      "id": "orders",
      "title": "Orders and emails",
      "how": "Paid orders: list_orders and get_order, update_order_status to shipped. Order requests: query_documents on order_requests. With the Mail module on, send the buyer a confirmation with send_email (transactional) from the user's own domain (add_email_domain, verify_email_domain); otherwise tell the user to send it themselves.",
      "tools": [
        "list_orders",
        "get_order",
        "update_order_status",
        "query_documents",
        "send_email",
        "add_email_domain",
        "verify_email_domain"
      ]
    },
    {
      "id": "contact_form",
      "title": "Contact form that really arrives",
      "how": "create_collection \"contact\" with access {\"public_write\": true} and triggers {\"email_on_insert\": true}, then get_form_snippet on /contact.",
      "tools": [
        "create_collection",
        "get_form_snippet"
      ]
    },
    {
      "id": "accounts",
      "title": "Customer accounts (optional)",
      "how": "Only if the user wants customers to log in and see their orders: deploy_app with auth, and set_table_owner_column so each customer sees only their own rows. A shop works fine without accounts.",
      "tools": [
        "deploy_app",
        "set_table_owner_column"
      ],
      "optional": true
    },
    {
      "id": "chat",
      "title": "Chat that knows the shop (optional)",
      "how": "create_collection \"faq\" with access {\"assistant_read\": true}, insert_document with shipping, returns and opening hours, then create_chat_widget with the site's origin and put the embed code on the site.",
      "tools": [
        "create_collection",
        "insert_document",
        "create_chat_widget"
      ],
      "optional": true
    },
    {
      "id": "structured_data",
      "title": "Structured data for search",
      "how": "Add the Product block from structured_data.snippet to the head of each product page (one Product block per product, with that product's own name, price and image) with deploy_site and keep_existing: true. Replace every YOUR ... placeholder with the user's real details from the answers so far; never invent an address, phone number, price or opening hours, and leave out optional fields you do not know. check_readiness flags blocks that are incomplete or still have placeholders.",
      "tools": [
        "deploy_site"
      ],
      "optional": true
    },
    {
      "id": "launch",
      "title": "Before launch",
      "how": "check_readiness for the site, fix what you can, and label_site_version \"before launch\" so this state is kept. Then tell the user in plain words what works and what does not yet.",
      "tools": [
        "check_readiness",
        "label_site_version"
      ]
    }
  ],
  "go_live_checklist": [
    {
      "id": "company_details",
      "level": "usually_required",
      "description": "Company details on the site, easy to find (footer or contact page): the legal name, the geographic address, an email address and a phone number, the chamber of commerce or company registration number, and the VAT number if the business has one. In the Netherlands: the KvK number and the btw-id.",
      "why": "EU and UK rules for online services and distance selling ask businesses to say who they are and how to reach them. Customers also trust a shop more when they see a real business behind it.",
      "how_on_hypamoon": "Ask the user for these details (never invent them), put them on /contact and in the footer of every page with deploy_site.",
      "checked_by_check_readiness": true
    },
    {
      "id": "privacy_statement",
      "level": "usually_required",
      "description": "A privacy statement that says which personal data the site collects (forms, orders, bookings, chat), why, how long it is kept, who processes it, and how people can see or delete their data.",
      "why": "The GDPR (EU) and UK GDPR require this as soon as you collect personal data; in the US, California (CalOPPA) requires a posted privacy policy for sites that collect personal information from California residents.",
      "how_on_hypamoon": "Write it with the user from what the site really collects, put it on /privacy with deploy_site and link it in the footer and next to every form.",
      "checked_by_check_readiness": true
    },
    {
      "id": "cookie_notice",
      "level": "recommended",
      "description": "A cookie notice with a real choice, but only if the site uses non-essential cookies or trackers (analytics with personal data, advertising pixels, embedded videos that set cookies). A site with only functional storage needs no banner.",
      "why": "The ePrivacy rules (EU) and PECR (UK) require consent before non-essential cookies are set. A banner that is not needed only gets in the way.",
      "how_on_hypamoon": "Hypamoon sites, forms, checkout and the chat widget need no cookie banner by themselves. If the user adds a tracker, add a consent banner that loads it only after a yes.",
      "checked_by_check_readiness": false
    },
    {
      "id": "accessibility",
      "level": "recommended",
      "description": "Basic accessibility: readable contrast, alt text on images, labels on form fields, keyboard navigation, and an accessibility statement for online shops and services.",
      "why": "The European Accessibility Act applies to e-commerce and many consumer services since 28 June 2025; micro-enterprises (fewer than 10 staff and at most 2 million euro turnover) are usually exempt for services. Accessible sites also sell better.",
      "how_on_hypamoon": "Build the pages with labels, alt text and enough contrast; add /accessibility if the business is not a micro-enterprise.",
      "checked_by_check_readiness": false
    },
    {
      "id": "prices_incl_vat",
      "level": "usually_required",
      "description": "Prices for consumers shown as the total price, VAT included, with the currency (for example € 19,95).",
      "why": "Consumer law in the EU and UK requires the total price including taxes; a price without currency or VAT confuses buyers.",
      "how_on_hypamoon": "Show prices with the currency on the page; with checkout, price_cents in the product collection is the price including VAT.",
      "checked_by_check_readiness": true
    },
    {
      "id": "terms_and_conditions",
      "level": "recommended",
      "description": "Terms and conditions on /terms, linked in the footer and in the order flow, that the customer can read and save before ordering.",
      "why": "Not every country requires them, but if the shop uses them, customers must be able to read them before they order; they also set delivery, payment and liability.",
      "how_on_hypamoon": "Write them with the user, put them on /terms with deploy_site and link them next to the order button.",
      "checked_by_check_readiness": true
    },
    {
      "id": "withdrawal_right",
      "level": "usually_required",
      "description": "Information about the 14-day right of withdrawal (cancellation): how to withdraw, who pays return shipping, the refund within 14 days, the exceptions (for example made-to-order or sealed hygiene products), and the model withdrawal form.",
      "why": "The EU Consumer Rights Directive and the UK Consumer Contracts Regulations give consumers 14 days to cancel most online purchases; without the information the period can be extended by up to 12 months.",
      "how_on_hypamoon": "Put it on /returns with the model withdrawal form, link it in the footer and from the order flow (deploy_site).",
      "checked_by_check_readiness": true
    },
    {
      "id": "withdrawal_function",
      "level": "usually_required",
      "description": "An easy way to withdraw online: a clearly labelled withdrawal function (like \"withdraw from contract here\") where the customer confirms their withdrawal, followed by a confirmation.",
      "why": "An EU amendment to the Consumer Rights Directive (Directive 2023/2673) asks for an online withdrawal function for contracts made online, applying from 19 June 2026.",
      "how_on_hypamoon": "A form on /returns that saves the withdrawal in a collection (create_collection with public_write and email_on_insert, get_form_snippet) and shows a confirmation.",
      "checked_by_check_readiness": false
    },
    {
      "id": "shipping_costs_upfront",
      "level": "usually_required",
      "description": "Shipping costs, delivery restrictions (countries) and the expected delivery time shown before the customer starts ordering.",
      "why": "In the EU and UK this information must be clear at the start of the ordering process; everywhere, hidden costs at the end are the main reason people abandon a purchase.",
      "how_on_hypamoon": "Show shipping costs on the product pages and next to the order button (deploy_site).",
      "checked_by_check_readiness": false
    },
    {
      "id": "payment_methods_upfront",
      "level": "usually_required",
      "description": "The accepted payment methods shown at the latest at the start of the ordering process.",
      "why": "The Consumer Rights Directive asks for this at the start of the order.",
      "how_on_hypamoon": "List the methods of the user's payment account on the product page or in the footer.",
      "checked_by_check_readiness": false
    },
    {
      "id": "order_button_text",
      "level": "usually_required",
      "description": "The final order button says clearly that ordering means paying, like \"Order with obligation to pay\" or in Dutch \"Bestellen en betalen\"; not just \"Next\" or \"Continue\".",
      "why": "The EU Consumer Rights Directive and the UK rules require this; without it the customer may not be bound by the order.",
      "how_on_hypamoon": "Set the button text on the checkout button (get_checkout_snippet html) or the order request button.",
      "checked_by_check_readiness": false
    },
    {
      "id": "order_confirmation",
      "level": "usually_required",
      "description": "An order confirmation by email (a durable medium) with what was ordered, the price, the company details and the withdrawal information.",
      "why": "EU and UK consumer law ask for a confirmation on a durable medium at the latest at delivery; customers everywhere expect one right away.",
      "how_on_hypamoon": "Check what the checkout or the payment provider already sends; add one with send_email (Mail module) if needed, or tell the user to send it.",
      "checked_by_check_readiness": false
    },
    {
      "id": "legal_guarantee",
      "level": "recommended",
      "description": "A line about the legal guarantee: products must be as promised, and consumers keep their legal rights when something is wrong.",
      "why": "The legal guarantee applies anyway (at least two years in most EU countries; in the Netherlands what the buyer may reasonably expect); saying so avoids disputes.",
      "how_on_hypamoon": "Add it to /terms or /returns with deploy_site.",
      "checked_by_check_readiness": false
    },
    {
      "id": "complaints",
      "level": "recommended",
      "description": "How to complain, with an email address and a reasonable answer time, and the dispute body if the business is a member of one (in the Netherlands for example the Geschillencommissie or a trade association).",
      "why": "The EU ODR platform closed on 20 July 2025 and the link is no longer needed, but a clear complaint route is still expected, and members of a dispute body must mention it.",
      "how_on_hypamoon": "Add it to /terms or /contact with deploy_site.",
      "checked_by_check_readiness": false
    },
    {
      "id": "age_check",
      "level": "usually_required",
      "description": "An age check when selling age-restricted products (alcohol, tobacco and vapes, knives, some games): ask for confirmation online and check the ID at delivery.",
      "why": "Selling these to minors is forbidden; in the Netherlands the Alcoholwet requires an age check at the door for alcohol delivered to the home.",
      "how_on_hypamoon": "Only if relevant: add an age statement to the order form and tell the user to arrange the check at delivery.",
      "checked_by_check_readiness": false
    },
    {
      "id": "vat_registration",
      "level": "recommended",
      "description": "VAT set up correctly: the right rate in the prices, and the EU One Stop Shop (OSS) when sales to consumers in other EU countries pass 10,000 euro a year.",
      "why": "Above that threshold the VAT of the buyer's country applies.",
      "how_on_hypamoon": "Nothing to build; mention it to the user so they check it with their accountant.",
      "checked_by_check_readiness": false
    },
    {
      "id": "checkout_real",
      "level": "usually_required",
      "description": "Every buy, order or add-to-cart button leads to a real checkout or a real order request; a cart always ends in one.",
      "why": "A button that does nothing loses the sale and makes the shop look fake.",
      "how_on_hypamoon": "get_checkout_snippet when payments are ready, otherwise an order request form (create_collection, get_form_snippet).",
      "checked_by_check_readiness": true
    },
    {
      "id": "structured_data",
      "level": "recommended",
      "description": "Structured data (JSON-LD from schema.org) that tells search engines what the business or product is: name, address, phone, opening hours, prices.",
      "why": "Search engines can then show richer results, like opening hours, a price or a location on the map, instead of a plain link.",
      "how_on_hypamoon": "Add the block from get_advice (structured_data.snippet) with the user's real details, with deploy_site and keep_existing: true.",
      "checked_by_check_readiness": true
    },
    {
      "id": "forms_saved",
      "level": "usually_required",
      "description": "Every form really saves what a visitor sends (in a collection or through an app), and the owner sees or gets each entry.",
      "why": "A form that goes nowhere loses customers without anyone noticing. This is not a law; it is what makes the site work.",
      "how_on_hypamoon": "create_collection with public_write (and email_on_insert so the owner gets each entry), then get_form_snippet and deploy_site.",
      "checked_by_check_readiness": true
    },
    {
      "id": "no_placeholders",
      "level": "usually_required",
      "description": "No lorem ipsum, example.com, \"your text here\" or other placeholder text, and no invented reviews, customers or numbers presented as real.",
      "why": "Placeholders look unfinished; invented reviews or customers are misleading and, for consumers, an unfair commercial practice in the EU and UK.",
      "how_on_hypamoon": "Replace placeholders with the user's real text, or leave the section out until they have it (deploy_site with keep_existing).",
      "checked_by_check_readiness": true
    },
    {
      "id": "no_test_wording",
      "level": "usually_required",
      "description": "No test wording on the live site, like \"this is a test form\" or \"test environment\", once it is meant for real visitors.",
      "why": "Visitors stop trusting a form that says it is a test, and they will not send real requests.",
      "how_on_hypamoon": "Change the texts (and data-hypamoon-success on forms) with deploy_site, and make sure the form uses the live public token.",
      "checked_by_check_readiness": true
    },
    {
      "id": "internal_links",
      "level": "recommended",
      "description": "Every link inside the site leads to a page that exists, and buttons go somewhere real.",
      "why": "Broken links and dead buttons make a site look like a mockup.",
      "how_on_hypamoon": "Add the missing pages or fix the links with deploy_site.",
      "checked_by_check_readiness": true
    },
    {
      "id": "not_found_page",
      "level": "recommended",
      "description": "A friendly not-found page (/404.html) with a link back home and the contact details.",
      "why": "Old links and typos end there; a plain error page loses the visitor.",
      "how_on_hypamoon": "Add /404.html with deploy_site.",
      "checked_by_check_readiness": true
    },
    {
      "id": "no_fake_login",
      "level": "usually_required",
      "description": "No login that checks a password in JavaScript, and no member area that only hides content in the browser.",
      "why": "Anyone can read the password in the page source; it protects nothing and gives the owner a false sense of safety.",
      "how_on_hypamoon": "One shared password: password on deploy_site. Accounts per person: deploy_app with auth. Paid access: create_access_product and set_site_access.",
      "checked_by_check_readiness": true
    },
    {
      "id": "no_local_storage_db",
      "level": "usually_required",
      "description": "Orders, bookings, sign-ups and messages are not kept in the visitor's browser (localStorage) as if it were a database.",
      "why": "localStorage stays on the visitor's own device: the owner never sees it, and it is gone when they clear their browser.",
      "how_on_hypamoon": "Save it in a collection (create_collection, get_form_snippet) or through an app (deploy_app). localStorage is fine for a theme or language choice.",
      "checked_by_check_readiness": true
    }
  ],
  "pitfalls": [
    {
      "id": "fake_checkout",
      "pitfall": "A \"Pay now\" or \"Add to cart\" button that does nothing, or a cart that only lives in the browser.",
      "instead": "The real checkout when payments are ready, otherwise an honest order request that says payment follows later."
    },
    {
      "id": "price_in_page",
      "pitfall": "Trusting a price that the page sends to the server.",
      "instead": "The checkout always reads price_cents from the product collection; show the price as text on the page."
    },
    {
      "id": "no_shipping_costs",
      "pitfall": "Shipping costs that only appear at the end.",
      "instead": "Show shipping costs on the product page and before the order button."
    },
    {
      "id": "no_withdrawal",
      "pitfall": "No returns page or withdrawal form for consumers.",
      "instead": "A /returns page with the 14-day rules and the model form, linked in the footer."
    },
    {
      "id": "invented_reviews",
      "pitfall": "Invented reviews, star ratings or \"1,000 happy customers\".",
      "instead": "Only real reviews from the user, or none."
    },
    {
      "id": "variants_as_one",
      "pitfall": "Variants with different prices in one product.",
      "instead": "Each variant with its own price as its own product."
    },
    {
      "id": "forgot_order_email",
      "pitfall": "Orders that nobody sees.",
      "instead": "email_on_insert on order requests, list_orders for paid orders, and a clear owner email."
    },
    {
      "id": "users_round_trip",
      "pitfall": "App code that fetches /app-users itself on every page to show the people of the app.",
      "instead": "Read users via env.HYPAMOON.users: env.HYPAMOON.users.list() or env.HYPAMOON.users.get(id) in the app's server code, usually answered next to the app without a round trip."
    }
  ],
  "structured_data": {
    "schema_type": "Product",
    "why": "Search engines can show the product with its price and whether it is in stock. Use one block per product page, with that product's own details.",
    "snippet": "<script type=\"application/ld+json\">\n{\n  \"@context\": \"https://schema.org\",\n  \"@type\": \"Product\",\n  \"name\": \"YOUR PRODUCT NAME\",\n  \"description\": \"YOUR PRODUCT DESCRIPTION\",\n  \"image\": \"YOUR PRODUCT IMAGE URL (absolute, https)\",\n  \"offers\": {\n    \"@type\": \"Offer\",\n    \"price\": \"YOUR PRICE (like 19.95)\",\n    \"priceCurrency\": \"YOUR CURRENCY CODE (like EUR)\",\n    \"availability\": \"https://schema.org/InStock\",\n    \"url\": \"YOUR PRODUCT PAGE URL\"\n  }\n}\n</script>",
    "required": [
      "name",
      "offers.price",
      "offers.priceCurrency"
    ]
  },
  "note": "This is guidance to help the user prepare, not legal or tax advice. Rules differ per country and change over time; for anything that matters, the user checks with an advisor or the official sources (in the Netherlands for example ACM ConsuWijzer for consumer law, the Belastingdienst for VAT and the Autoriteit Persoonsgegevens for privacy).",
  "other_types": {
    "available": [
      "webshop",
      "bookings",
      "restaurant",
      "course_membership",
      "wordpress_portal"
    ],
    "planned": [
      "events",
      "portfolio",
      "internal_tool",
      "saas"
    ]
  },
  "known_problems": [
    {
      "id": "sandbox_blocks_upload",
      "symptom": "The PUT to an upload_url fails or is blocked from your own environment (a 403, a network error, \"host not allowed\"), or deploy_site says upload_not_received.",
      "what_to_do": "This is your sandbox, not Hypamoon: do not say Hypamoon is down or blocked. Send images under ~3 MB as base64 in deploy_site content instead. Files that are already online go as source_url in deploy_site (up to 100 per call). For larger or many local files, create_drop_link, give the user the url, and after they are done call get_drop and deploy its deploy_files; the user can also add them at https://app.hypamoon.com/media, after which deploy_site finds them by path, sha256 and bytes.",
      "tell_user": "Your chat app blocked the upload, not Hypamoon. I will send the file another way, or give you a link to upload it yourself in your browser."
    },
    {
      "id": "image_too_large",
      "symptom": "site_too_large, or one request over 4 MB because of an image.",
      "what_to_do": "Make a lighter copy first: at most about 2000 px wide, JPEG or WebP at quality ~80; that is usually under 500 KB and looks the same on screen. A file that must stay large goes through create_upload_urls, or create_drop_link if your environment cannot upload. The limits per file are in the error and in limits of create_upload_urls.",
      "tell_user": "That image is bigger than a website needs. I will make a lighter copy that looks the same on screen."
    },
    {
      "id": "version_conflict",
      "symptom": "version_conflict (409 or 412) on deploy_site or set_call_plan.",
      "what_to_do": "Something changed since you read it (another chat, a team member, the portal). Read it again (get_site or get_call_plan), apply your change on top of the current version, and send it with if_match_version set to current_version from the error. Never retry without reading, and never overwrite blindly.",
      "tell_user": "The site changed in the meantime, so I did not overwrite it. I will apply your change to the latest version."
    },
    {
      "id": "phone_verification_required",
      "symptom": "phone_verification_required (403) when making a site public or connecting a domain.",
      "what_to_do": "The account owner verifies their phone once at the verify_url in the error (https://app.hypamoon.com/verify-phone); a payment method also counts. Until then the site works with a password or as unlisted. Do not try to work around it.",
      "tell_user": "Before the site can be public, please confirm your phone number once at the link I give you. It takes about a minute."
    },
    {
      "id": "site_not_visible",
      "symptom": "The user says the site works for them but not for others, or it does not show up in Google.",
      "what_to_do": "Check get_site: an unlisted site only opens with its secret link, and a site with a password asks every visitor for it. update_site_address makes it public (that may need phone verification); rotate_site_secret_url makes a new secret link. A new public site takes days to appear in Google; check_readiness covers findability.",
      "tell_user": "Your site is live, but it is set to private, so only people with the secret link can open it. I can make it public if you want."
    },
    {
      "id": "is_hypamoon_down",
      "symptom": "A step failed and it looks like Hypamoon might be down.",
      "what_to_do": "Call get_status before you say anything about an outage. Operational: the problem is in the failing step or in your own environment; read its user_message and fix that step. A reported problem: tell the user what is affected and link https://status.hypamoon.com; retry later instead of inventing a workaround.",
      "tell_user": "Hypamoon is working normally. The problem is likely in your chat app. (Use the user_message from get_status; it says so when there is a real problem.)"
    }
  ],
  "summary_markdown": "## Webshop (EU, NL, selling to consumers)\nA shop on the user's own site: products, a real checkout (or an honest order request while payments are not on), order emails and the pages a shop needs to go live.\n\n**Ask only these, if not answered yet:** Which country is your business in, and where do you sell to? What do you sell, and roughly how many products? Do they come in variants like size or color?\n**Defaults for the rest:** seller: A business selling to consumers.; shipping: One flat shipping rate within the country, shown on every product page and before checkout; pickup on request.; returns: The legal minimum: 14 days to withdraw, the customer pays return shipping, refund within 14 days.; stock: No stock tracking (unlimited); the owner takes a product off sale by hand.; payment_methods: What the user's own payment account offers (in the Netherlands usually iDEAL and cards).; order_emails: The project's billing email address.; language_currency: The language and currency of the user's country.\n\n**Build plan:**\n1. Pages first: deploy_site\n2. Products as data: create_product_collection, create_collection, insert_document\n3. A real checkout, or an honest order request: get_payments_status, connect_payments, get_checkout_snippet, create_collection, get_form_snippet\n4. Orders and emails: list_orders, get_order, update_order_status, query_documents, send_email, add_email_domain, verify_email_domain\n5. Contact form that really arrives: create_collection, get_form_snippet\n6. Customer accounts (optional) (optional): deploy_app, set_table_owner_column\n7. Chat that knows the shop (optional) (optional): create_collection, insert_document, create_chat_widget\n8. Structured data for search (optional): deploy_site\n9. Before launch: check_readiness, label_site_version\n\n**Before going live (offer it, do not impose it):** 16 usually required and 9 recommended points; check_readiness verifies 14 of them on the site.\n\n**Common mistakes:** A \"Pay now\" or \"Add to cart\" button that does nothing, or a cart that only lives in the browser. Trusting a price that the page sends to the server. Shipping costs that only appear at the end. No returns page or withdrawal form for consumers. Invented reviews, star ratings or \"1,000 happy customers\". Variants with different prices in one product. Orders that nobody sees. App code that fetches /app-users itself on every page to show the people of the app.\n\n_This is guidance to help the user prepare, not legal or tax advice. Rules differ per country and change over time; for anything that matters, the user checks with an advisor or the official sources (in the Netherlands for example ACM ConsuWijzer for consumer law, the Belastingdienst for VAT and the Autoriteit Persoonsgegevens for privacy)._"
}

{
  "sites": [
    "bakkerij-jansen"
  ]
}

{
  "id": "0f6c2a8e-7d3b-4c1e-9a55-2b8f6d4e1c90",
  "status": "done",
  "from_project": {
    "id": "6b1d2c3e-4f50-4a6b-8c7d-9e0f1a2b3c4d",
    "name": "Bakkerij Jansen (test)",
    "mode": "test"
  },
  "to_project": {
    "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "name": "Bakkerij Jansen",
    "mode": "live"
  },
  "moved": {
    "sites": [
      {
        "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
        "slug": "bakkerij-jansen",
        "url": "https://bakkerij-jansen.hypamoon.app",
        "new_version": 7,
        "form_token_replaced": true
      }
    ],
    "collections": [
      {
        "id": "7a8b9c0d-1e2f-4a3b-8c4d-5e6f7a8b9c0d",
        "name": "contact",
        "documents": 12
      }
    ],
    "copied_collections": [],
    "apps": [],
    "agents": [],
    "domains": [],
    "form_tokens": [
      {
        "name": "Website form",
        "live_token_id": "9c0d1e2f-3a4b-4c5d-8e6f-7a8b9c0d1e2f",
        "replaces_test_token_id": "2f3a4b5c-6d7e-4f8a-9b0c-1d2e3f4a5b6c"
      }
    ],
    "webhooks": 0
  },
  "stayed_in_test": {
    "sites": [],
    "collections": [],
    "simulated_domains": []
  },
  "warnings": [],
  "errors": [],
  "undo": {
    "until": "2026-10-10T09:00:00.000Z",
    "how": "undo_move_to_live with move_id 0f6c2a8e-7d3b-4c1e-9a55-2b8f6d4e1c90 (POST /project/move-to-live/undo with {\"move_id\": \"0f6c2a8e-7d3b-4c1e-9a55-2b8f6d4e1c90\"}), until 2026-10-10T09:00:00.000Z."
  },
  "connection": {
    "mode": "test",
    "note": "This connection still points to the test project, where these sites no longer are. It keeps working there until it is reconnected or switched."
  },
  "summary": "Moved 1 site (bakkerij-jansen) with all versions, 1 collection with 12 documents and a new live form token from Bakkerij Jansen (test) to Bakkerij Jansen. Nothing else was in the test project. This can be undone until 2026-10-10T09:00:00.000Z with undo_move_to_live.",
  "next_step": "Reconnect your chat to Hypamoon and choose Bakkerij Jansen (not test), or switch this connection in the portal under Connections (Switch to live; you confirm the access again there). Check the sites at their address; forms now save to the live project. To put the user's own domain on a site: connect_domain with the site_id from the live project (through the nameservers it is free)."
}

{
  "move_id": "0f6c2a8e-7d3b-4c1e-9a55-2b8f6d4e1c90"
}

{
  "id": "0f6c2a8e-7d3b-4c1e-9a55-2b8f6d4e1c90",
  "status": "undone",
  "sites": [
    "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
  ],
  "collections": 1,
  "apps": 0,
  "agents": 0,
  "domains": 0,
  "errors": [],
  "summary": "Moved 1 site and 1 collection back from Bakkerij Jansen to Bakkerij Jansen (test).",
  "next_step": "The sites are in the test project again, with the test form token. Use the test connection or a test key to work on them."
}

{
  "data": [
    {
      "id": "48213",
      "at": "2026-10-12T14:03:11.402Z",
      "source": "mcp",
      "client": "chatgpt",
      "tool": "deploy_site",
      "route": null,
      "error": "validation_failed",
      "status": 422,
      "detail": "Some files could not be fetched. See 'errors'.",
      "duration_ms": 8123,
      "request_id": "req_7Hq2LmX9pRt4VwZ1aB3c",
      "mode": "live",
      "arguments": {
        "name": "string(12)",
        "files": {
          "type": "array",
          "n": 14,
          "fields": {
            "path": 14,
            "content": 11,
            "source_url": 3
          },
          "chars": 48211
        }
      },
      "field_errors": [
        {
          "path": "files.12.source_url",
          "message": "images.example.com answered HTTP 403: it blocks downloads by servers. Upload the file with create_upload_urls instead."
        }
      ]
    }
  ],
  "next_before": null,
  "dropped_today": 0
}

{
  "balance_eur": 24.46,
  "currency": "EUR",
  "spent_this_month_eur": 0.3,
  "spend_cap_eur": 100,
  "auto_reload": {
    "enabled": true,
    "active": true,
    "threshold_eur": 5,
    "amount_eur": 20,
    "max_per_month": 10,
    "used_this_month": 1,
    "disabled_reason": null,
    "card": {
      "brand": "Visa",
      "last4": "4242",
      "expiry": "2028-12-31"
    }
  },
  "transactions": [
    {
      "id": "6e5d4c3b-2a19-4f8e-8d7c-6b5a4e3d2c1b",
      "type": "charge",
      "source": "sms",
      "amount_eur": -0.3,
      "balance_after_eur": 24.46,
      "description": "SMS, 2 segments",
      "quantity": 2,
      "unit": "segment",
      "reference_id": "8f7e6d5c-4b3a-4291-8f0e-1d2c3b4a5968",
      "created_at": "2026-10-01T10:02:00.000Z"
    },
    {
      "id": "4c3b2a19-0f8e-4d7c-9b6a-5e4d3c2b1a09",
      "type": "top_up",
      "source": "payment",
      "amount_eur": 20,
      "balance_after_eur": 24.76,
      "description": "Top-up",
      "quantity": null,
      "unit": null,
      "reference_id": "b7e5a1c4-2d93-4f60-8a1e-9c3d5b7f2e10",
      "created_at": "2026-10-01T09:30:00.000Z"
    }
  ],
  "test": false
}

{
  "data": [
    {
      "id": "5f0c9a2e-8b1d-4c3f-a6e7-2d9b0c1e4f53",
      "e164": "+•••••••••42",
      "type": "national",
      "status": "active",
      "created_at": "2026-10-01T09:00:00.000Z",
      "test": false
    }
  ]
}

{
  "area": "020"
}

{
  "id": "5f0c9a2e-8b1d-4c3f-a6e7-2d9b0c1e4f53",
  "e164": "+•••••••••42",
  "type": "national",
  "status": "active",
  "created_at": "2026-10-01T09:00:00.000Z",
  "test": false,
  "from_stock": true
}

{
  "data": [
    {
      "e164": "+•••••••••42",
      "type": "national",
      "from_stock": true,
      "test": false
    }
  ]
}

{
  "id": "0d1e2f3a-4b5c-4d6e-8f70-8192a3b4c5d6",
  "e164": "+447700900042",
  "released": true,
  "test": true
}

{
  "configured": true,
  "voice": "ava",
  "language": "en",
  "languages": [
    "en"
  ],
  "speech_recognition": "en",
  "instructions": "You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.",
  "website": "https://acme-plumbing.example/",
  "greeting": "You are speaking with the digital assistant of Acme Plumbing. How can I help you?",
  "synced_at": "2026-10-01T09:00:00.000Z"
}

{
  "language": "en",
  "voice": "ava",
  "instructions": "You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.",
  "website": "https://acme-plumbing.example"
}

{
  "configured": true,
  "voice": "ava",
  "language": "en",
  "languages": [
    "en"
  ],
  "speech_recognition": "en",
  "instructions": "You answer for Acme Plumbing. Ask for the address and the problem, and tell the caller we call back within the hour. Never quote prices.",
  "website": "https://acme-plumbing.example/",
  "greeting": "You are speaking with the digital assistant of Acme Plumbing. How can I help you?",
  "synced_at": "2026-10-01T09:00:00.000Z",
  "sync": "synced",
  "call_plan": "added",
  "next_step": "Nothing else is needed: the assistant answers every call, and callers can leave a message if it is not available. To ring a team first, PUT /numbers/{id}/call-plan.",
  "user_message": "Your assistant is ready and answers every call. If it is ever not available, callers can leave a message."
}

{
  "number_id": "5f0c9a2e-8b1d-4c3f-a6e7-2d9b0c1e4f53",
  "version": 1,
  "source": "number",
  "plan": {
    "entry": "team",
    "nodes": {
      "team": {
        "id": "team",
        "type": "forward",
        "strategy": "sequential",
        "targets": [
          {
            "kind": "external",
            "e164": "+447700900123"
          }
        ],
        "ringSeconds": 20,
        "onNoAnswer": "ai"
      },
      "ai": {
        "id": "ai",
        "type": "ai_agent"
      }
    }
  }
}

{
  "entry": "team",
  "nodes": {
    "team": {
      "id": "team",
      "type": "forward",
      "strategy": "sequential",
      "targets": [
        {
          "kind": "external",
          "e164": "+447700900123"
        }
      ],
      "ringSeconds": 20,
      "onNoAnswer": "ai"
    },
    "ai": {
      "id": "ai",
      "type": "ai_agent"
    }
  }
}

{
  "number_id": "5f0c9a2e-8b1d-4c3f-a6e7-2d9b0c1e4f53",
  "version": 1,
  "plan": {
    "entry": "team",
    "nodes": {
      "team": {
        "id": "team",
        "type": "forward",
        "strategy": "sequential",
        "targets": [
          {
            "kind": "external",
            "e164": "+447700900123"
          }
        ],
        "ringSeconds": 20,
        "onNoAnswer": "ai"
      },
      "ai": {
        "id": "ai",
        "type": "ai_agent"
      }
    }
  },
  "assistant_sync": "synced"
}

{
  "data": [
    {
      "id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "direction": "inbound",
      "from": "+447700900456",
      "to": "+•••••••••42",
      "status": "ai_handled",
      "created_at": "2026-10-01T09:14:02.000Z",
      "started_at": "2026-10-01T09:14:02.000Z",
      "answered_at": "2026-10-01T09:14:03.000Z",
      "ended_at": "2026-10-01T09:15:37.000Z",
      "duration_sec": 94,
      "hangup_cause": "normal_clearing",
      "has_summary": true,
      "summary_ready_at": null,
      "test": false,
      "outbound": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}

{
  "to": "+447700900321",
  "assistant_instructions": "Confirm the appointment of Sam Taylor tomorrow at 10:00 at 40 Main Street. If Sam cannot make it, ask which day suits better and say we will confirm by SMS.",
  "on_voicemail": "leave_message",
  "voicemail_message": "We called about your appointment tomorrow at 10:00. Call us back on this number if you cannot make it.",
  "max_duration_sec": 300,
  "reference": "appointment-8812",
  "metadata": {
    "customer_id": "cus_4821"
  }
}

{
  "id": "b7c8d9e0-f1a2-4b3c-8d4e-5f6a7b8c9d0e",
  "direction": "outbound",
  "from": "+•••••••••42",
  "to": "+447700900321",
  "status": "ringing",
  "created_at": "2026-10-01T09:00:00.000Z",
  "started_at": "2026-10-01T09:00:00.000Z",
  "answered_at": null,
  "ended_at": null,
  "duration_sec": null,
  "hangup_cause": null,
  "has_summary": false,
  "summary_ready_at": null,
  "test": false,
  "outbound": {
    "status": "ringing",
    "answered_by": null,
    "voicemail_left": false,
    "on_voicemail": "leave_message",
    "max_duration_sec": 300,
    "reference": "appointment-8812",
    "metadata": {
      "customer_id": "cus_4821"
    },
    "error": null,
    "purpose": "transactional"
  },
  "transcript": null,
  "summary": null
}

{
  "id": "c1a2b3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "direction": "inbound",
  "from": "+447700900456",
  "to": "+•••••••••42",
  "status": "ai_handled",
  "created_at": "2026-10-01T09:14:02.000Z",
  "started_at": "2026-10-01T09:14:02.000Z",
  "answered_at": "2026-10-01T09:14:03.000Z",
  "ended_at": "2026-10-01T09:15:37.000Z",
  "duration_sec": 94,
  "hangup_cause": "normal_clearing",
  "has_summary": true,
  "summary_ready_at": null,
  "test": false,
  "outbound": null,
  "transcript": "Assistant: U spreekt met de digitale assistent van Acme Plumbing. Waarmee kan ik u helpen?\nCaller: My kitchen tap is leaking, can someone come today?",
  "summary": {
    "text": "The caller has a leaking kitchen tap and wants someone to come today.",
    "topics": [
      "leak",
      "appointment"
    ],
    "sentiment": "neutral",
    "action_items": [
      "Call back within the hour to plan a visit."
    ],
    "next_step": "Plan a visit today."
  }
}

{
  "data": [
    {
      "id": "5b8e2c1d-7a4f-4e3b-9c6d-1f2a3b4c5d6e",
      "phone_number_ending": "21",
      "source": "form",
      "evidence": "Newsletter sign-up form, entry 7f3c2a, box 'call me about offers' ticked",
      "consented_at": "2026-10-01T09:30:00.000Z",
      "recorded_at": "2026-10-01T09:30:02.000Z",
      "revoked_at": null,
      "status": "active"
    }
  ]
}

{
  "phone_number": "+447700900321",
  "source": "form",
  "evidence": "Newsletter sign-up form, entry 7f3c2a, box 'call me about offers' ticked",
  "consented_at": "2026-10-01T09:30:00Z"
}

{
  "id": "5b8e2c1d-7a4f-4e3b-9c6d-1f2a3b4c5d6e",
  "phone_number_ending": "21",
  "source": "form",
  "evidence": "Newsletter sign-up form, entry 7f3c2a, box 'call me about offers' ticked",
  "consented_at": "2026-10-01T09:30:00.000Z",
  "recorded_at": "2026-10-01T09:30:02.000Z",
  "revoked_at": null,
  "status": "active"
}

{
  "id": "5b8e2c1d-7a4f-4e3b-9c6d-1f2a3b4c5d6e",
  "phone_number_ending": "21",
  "source": "form",
  "evidence": "Newsletter sign-up form, entry 7f3c2a, box 'call me about offers' ticked",
  "consented_at": "2026-10-01T09:30:00.000Z",
  "recorded_at": "2026-10-01T09:30:02.000Z",
  "revoked_at": null,
  "status": "active"
}

{
  "id": "5b8e2c1d-7a4f-4e3b-9c6d-1f2a3b4c5d6e",
  "phone_number_ending": "21",
  "source": "form",
  "evidence": "Newsletter sign-up form, entry 7f3c2a, box 'call me about offers' ticked",
  "consented_at": "2026-10-01T09:30:00.000Z",
  "recorded_at": "2026-10-01T09:30:02.000Z",
  "revoked_at": "2026-10-12T14:00:00.000Z",
  "status": "revoked"
}

{
  "data": [
    {
      "id": "9e8d7c6b-5a49-4382-9716-a5b4c3d2e1f0",
      "url": "https://your-app.example/hooks/hypamoon",
      "events": [
        "call.completed",
        "call.summary.ready"
      ],
      "active": true,
      "secret_prefix": "whsec_Xk3p",
      "created_at": "2026-10-01T09:00:00.000Z",
      "last_success_at": null,
      "last_failure_at": null,
      "consecutive_failures": 0
    }
  ]
}

{
  "url": "https://your-app.example/hooks/hypamoon",
  "events": [
    "call.completed",
    "call.summary.ready"
  ]
}

{
  "id": "9e8d7c6b-5a49-4382-9716-a5b4c3d2e1f0",
  "url": "https://your-app.example/hooks/hypamoon",
  "events": [
    "call.completed",
    "call.summary.ready"
  ],
  "active": true,
  "secret_prefix": "whsec_Xk3p",
  "created_at": "2026-10-01T09:00:00.000Z",
  "last_success_at": null,
  "last_failure_at": null,
  "consecutive_failures": 0,
  "secret": "whsec_Xk3pQ9vT2mLr8sYw4nBc6dFh1jKz5aGe7uIo0pRtVxE"
}

{
  "id": "9e8d7c6b-5a49-4382-9716-a5b4c3d2e1f0",
  "url": "https://your-app.example/hooks/hypamoon",
  "events": [
    "call.completed",
    "call.summary.ready"
  ],
  "active": true,
  "secret_prefix": "whsec_Xk3p",
  "created_at": "2026-10-01T09:00:00.000Z",
  "last_success_at": null,
  "last_failure_at": null,
  "consecutive_failures": 0
}

{
  "delivery_id": "3b2a1908-f7e6-4d5c-8b4a-392817160514",
  "event_id": "evt_4f1c2a9b8e7d6c5b4a39281706f5e4d3",
  "status": "delivered",
  "response_status": 204,
  "error": null
}

{
  "data": [
    {
      "id": "8f7e6d5c-4b3a-4291-8f0e-1d2c3b4a5968",
      "to": "+447700900321",
      "from": "Acme Shop",
      "body": "Hi Sam, thanks for your order 10432 at Acme Shop. We are packing it now; you get a track and trace link as soon as it ships.",
      "segments": 1,
      "encoding": "gsm7",
      "status": "queued",
      "error": null,
      "reference": "order-10432",
      "created_at": "2026-10-01T09:00:00.000Z",
      "status_updated_at": "2026-10-01T09:00:00.000Z",
      "test": true
    }
  ],
  "has_more": false,
  "next_cursor": null
}

{
  "to": "+447700900321",
  "body": "Hi Sam, thanks for your order 10432 at Acme Shop. We are packing it now; you get a track and trace link as soon as it ships.",
  "reference": "order-10432"
}

{
  "id": "8f7e6d5c-4b3a-4291-8f0e-1d2c3b4a5968",
  "to": "+447700900321",
  "from": "Acme Shop",
  "body": "Hi Sam, thanks for your order 10432 at Acme Shop. We are packing it now; you get a track and trace link as soon as it ships.",
  "segments": 1,
  "encoding": "gsm7",
  "status": "queued",
  "error": null,
  "reference": "order-10432",
  "created_at": "2026-10-01T09:00:00.000Z",
  "status_updated_at": "2026-10-01T09:00:00.000Z",
  "test": true
}

{
  "id": "8f7e6d5c-4b3a-4291-8f0e-1d2c3b4a5968",
  "to": "+447700900321",
  "from": "Acme Shop",
  "body": "Hi Sam, thanks for your order 10432 at Acme Shop. We are packing it now; you get a track and trace link as soon as it ships.",
  "segments": 1,
  "encoding": "gsm7",
  "status": "queued",
  "error": null,
  "reference": "order-10432",
  "created_at": "2026-10-01T09:00:00.000Z",
  "status_updated_at": "2026-10-01T09:00:00.000Z",
  "test": true
}

{
  "data": [
    {
      "id": "2c9d8e7f-6a5b-4c3d-9e2f-1a0b9c8d7e6f",
      "channel": "chat",
      "status": "closed",
      "reference": "session-8841",
      "metadata": {
        "page": "/pricing",
        "plan": "pro"
      },
      "customer": {
        "name": "Sam Jones",
        "phone": null,
        "email": "sam@example.com"
      },
      "language": "en",
      "turns": 2,
      "max_turns": 30,
      "created_at": "2026-10-01T09:00:00.000Z",
      "last_message_at": "2026-10-01T09:01:05.000Z",
      "closed_at": "2026-10-01T09:31:05.000Z",
      "close_reason": "inactive",
      "has_summary": true,
      "summary_ready_at": "2026-10-01T09:31:09.000Z",
      "test": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

{
  "reference": "session-8841",
  "metadata": {
    "page": "/pricing",
    "plan": "pro"
  },
  "customer": {
    "name": "Sam Jones",
    "email": "sam@example.com"
  }
}