# Hosting design brief update

`PATCH /hosting/sites/{id}/design/brief` · Rivier · hosting

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

- Scope: hosting:write
- Graphql: Mutation.hostingDesignBriefUpdate
- Sdk: hosting.designBrief.update
- Cli: hosting design brief update

## Parameters

- `id` (path, required), string

## Request body

`application/json`

```json
{
  "type": "object",
  "properties": {
    "goals": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 200
      },
      "maxItems": 10
    },
    "audience": {
      "type": "string",
      "maxLength": 300
    },
    "voice": {
      "type": "string",
      "maxLength": 300
    },
    "constraints": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 300
      },
      "maxItems": 30
    },
    "name": {
      "type": "string",
      "maxLength": 120
    },
    "summary": {
      "type": "string",
      "maxLength": 400
    },
    "languages": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 20
      },
      "minItems": 1,
      "maxItems": 30
    },
    "navigation": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "maxLength": 40
          },
          "path": {
            "type": "string",
            "maxLength": 120
          }
        },
        "required": [
          "label",
          "path"
        ],
        "additionalProperties": false
      },
      "maxItems": 12
    },
    "sitemap": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "maxLength": 120
          },
          "title": {
            "type": "string",
            "maxLength": 200
          },
          "purpose": {
            "type": "string",
            "maxLength": 300
          },
          "description": {
            "type": "string",
            "maxLength": 320
          },
          "sections": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "kind": {
                  "type": "string",
                  "enum": [
                    "hero",
                    "text",
                    "features",
                    "gallery",
                    "rooms",
                    "products",
                    "collection",
                    "faq",
                    "form",
                    "booking",
                    "cta",
                    "newsletter",
                    "testimonials",
                    "contact",
                    "account"
                  ]
                },
                "heading": {
                  "type": "string",
                  "maxLength": 120
                },
                "text": {
                  "type": "string",
                  "maxLength": 800
                },
                "items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "title": {
                        "type": "string",
                        "maxLength": 80
                      },
                      "text": {
                        "type": "string",
                        "maxLength": 300
                      }
                    },
                    "required": [
                      "title"
                    ],
                    "additionalProperties": false
                  },
                  "maxItems": 12
                },
                "cta": {
                  "type": "object",
                  "properties": {
                    "label": {
                      "type": "string",
                      "maxLength": 40
                    },
                    "url": {
                      "type": "string",
                      "maxLength": 300
                    }
                  },
                  "required": [
                    "label",
                    "url"
                  ],
                  "additionalProperties": false
                },
                "source": {
                  "type": "string",
                  "enum": [
                    "cms",
                    "shop",
                    "stays"
                  ]
                },
                "contentType": {
                  "type": "string",
                  "maxLength": 40
                },
                "view": {
                  "type": "string",
                  "enum": [
                    "sign-in",
                    "account",
                    "orders",
                    "bookings",
                    "stays",
                    "invoices",
                    "support",
                    "memberships",
                    "downloads",
                    "proofs",
                    "privacy"
                  ]
                }
              },
              "required": [
                "kind"
              ],
              "additionalProperties": false
            },
            "minItems": 1,
            "maxItems": 14
          }
        },
        "required": [
          "path",
          "title",
          "purpose",
          "sections"
        ],
        "additionalProperties": false
      },
      "maxItems": 40
    }
  },
  "additionalProperties": false
}
```

## Responses

- `200`: Success
- `400`: The request was malformed
- `401`: No valid credential
- `403`: The credential lacks the scope, origin or address
- `429`: Over the key's rate limit; see Retry-After

## Example

```sh
curl -X PATCH 'https://api.rivier.ai/hosting/sites/{id}/design/brief' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "goals": [
    "string"
  ],
  "audience": "string",
  "voice": "string",
  "constraints": [
    "string"
  ],
  "name": "string",
  "summary": "string",
  "languages": [
    "string"
  ],
  "navigation": [
    {
      "label": "string",
      "path": "string"
    }
  ]
}'
```