Create a brand

Creates a new brand.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

namestring · min: 1Required

The name of the brand.

Example: JFramework

abbrstring · min: 1Required

The abbreviation of the brand. The value is the abbreviation of the brand.

Example: JFW

descriptionstring · nullableOptional

The description of the brand.

Example: JFramework is a powerful framework for building web applications.

Responses

201

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

429

API call exceeded rate limit due to too many requests.

application/json

post

/api/v1/brands

HTTPcURLJavaScriptPython

POST /api/v1/brands HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 249

{
  "name": "JFramework",
  "abbr": "JFW",
  "description": "JFramework is a powerful framework for building web applications.",
  "setting": {
    "domain": "jframework.dev"
  },
  "profile": {
    "logoUrl": "https://example.com",
    "faviconUrl": "https://example.com",
    "slogan": "text"
  }
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "parentId": "sApKpllz4sAplsmzha",
    "code": "EXA",
    "name": "Example",
    "abbr": "EXA",
    "description": "JFW",
    "tags": "Example, JFW",
    "status": "Inactive",
    "isDefault": false,
    "isSystem": false,
    "profile": {
      "slogan": "Example Slogan",
      "logoURL": "https://www.example.com/logo.png",
      "faviconURL": "https://www.example.com/favicon.ico",
      "primaryColor": "#000000",
      "primaryColorHover": "#000000",
      "secondaryColor": "#000000",
      "tertiaryColor": "#000000"
    },
    "setting": {
      "domainWhiteListURLs": "https://whitelist.example.io",
      "googleAnalyticsAccount": "UA-******-1",
      "reCaptchaKey": "6Lc6BAAAAAAAAChqRbQZcn_yyyyyyyyyyyyyyyyy",
      "currencyCode": "EXA",
      "cdnURL": "https://cdn.example.com",
      "cdnFolder": "exam_cdn",
      "passwordPolicyLevel": "Low"
    },
    "domains": []
  },
  "errors": []
}