---
title: "Read your brand from your website"
method: POST
path: "/v1/brand/read-website"
tags: ["Your brand"]
---

# Read your brand from your website

`POST /v1/brand/read-website`

## Request

- Base URL: `https://app.verygoodletter.co/api`
- URL: `https://app.verygoodletter.co/api/v1/brand/read-website`
- Auth: HTTP bearer

Brings in your logo, colours, typeface, name and kind of business, and saves them as your brand.

Permission: **Read and write**.

## Request body

- object
  - `url` string, required: Your website, with or without https://.

## Response `200`

What it did, as JSON, with the mode it ran in.

- Answer
  - `mode` 'sandbox' | 'live', required: Which the request ran in: the key’s.

## Other responses

- `400`: What was sent needs changing. The error says what.
- `401`: No key, or one that’s been revoked.
- `403`: The key’s permission isn’t enough: this needs Read and write.
- `429`: More than 120 requests in a minute.

---

[API](https://skmtc.dev/verygoodletter/apis/the-very-good-letter-company-api.md) · [All operations](https://skmtc.dev/verygoodletter/apis/the-very-good-letter-company-api/llms.txt) · [OpenAPI document](https://skmtc.dev/verygoodletter/apis/the-very-good-letter-company-api/revisions/c735d65147f5?raw)