Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Enrichment
  3. Branding

Create brand

Create brand properties for the specified account.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/branding.write scope.

POST
/accounts/{accountID}/branding
cURL 
curl --request POST \
  --url https://api.moov.io/accounts/{accountID}/branding \
  --header 'Authorization: Basic REPLACE_BASIC_AUTH' \
  --header 'content-type: application/json' \
  --header 'x-moov-version: SOME_STRING_VALUE' \
  --data '{"colors":{"dark":{"accent":"#111111"},"light":{"accent":"#111111"}}}'
200 400 401 403 404 409 422 429 500 504
The request completed successfully.
{
  "colors": {
    "dark": {
      "accent": "#111111"
    },
    "light": {
      "accent": "#111111"
    }
  }
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
{
  "error": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
{
  "error": "string"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
  "colors": {
    "dark": {
      "accent": "string"
    },
    "light": {
      "accent": "string"
    }
  }
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

Body

application/json

colors

object required
Brand colors for light and dark modes.
Show child attributes

dark

object required
Show child attributes

accent

string required
A CSS hex color representing an accent color.

light

object required
Show child attributes

accent

string required
A CSS hex color representing an accent color.

Response

application/json

colors

object required
Brand colors for light and dark modes.
Show child attributes

dark

object required
Show child attributes

accent

string required
A CSS hex color representing an accent color.

light

object required
Show child attributes

accent

string required
A CSS hex color representing an accent color.