Praecise Platform
Menu

Rivier/ Reference/ hosting

Hosting design brief update

patch/hosting/sites/{id}/design/brief

Edit the brief directly (goals, audience, voice, constraints, name, sitemap, navigation).

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Graphql
Mutation.hostingDesignBriefUpdate
Sdk
hosting.designBrief.update
Cli
hosting design brief update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • goalslist of string
  • audiencestring
    At most 300 characters.
  • voicestring
    At most 300 characters.
  • constraintslist of string
  • namestring
    At most 120 characters.
  • summarystring
    At most 400 characters.
  • languageslist of string
  • navigationlist of object
    • labelstringrequired
      At most 40 characters.
    • pathstringrequired
      At most 120 characters.
  • sitemaplist of object
    • pathstringrequired
      At most 120 characters.
    • titlestringrequired
      At most 200 characters.
    • purposestringrequired
      At most 300 characters.
    • descriptionstring
      At most 320 characters.
    • sectionslist of objectrequired
      • kindstringrequired
        One of: hero, text, features, gallery, rooms, products, collection, faq, form, booking, cta, newsletter, testimonials, contact, account.
      • headingstring
        At most 120 characters.
      • textstring
        At most 800 characters.
      • itemslist of object
        • titlestringrequired
          At most 80 characters.
        • textstring
          At most 300 characters.
      • ctaobject
        • labelstringrequired
          At most 40 characters.
        • urlstringrequired
          At most 300 characters.
      • sourcestring
        One of: cms, shop, stays.
      • contentTypestring
        At most 40 characters.
      • viewstring
        One of: sign-in, account, orders, bookings, stays, invoices, support, memberships, downloads, proofs, privacy.

Responses

  • 200application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown