Create Brand

POST 
https://sight.inspectorio.com/api/v1/brands

Create Brand

Request

application/json

Body

brandIdstringrequired
Custom ID of the brand
Possible values: non-empty
Example: brand_1
descriptionstringnullable
Brand description
Example: Modern Menswear
namestringrequired
Name of the brand
Possible values: non-empty
Example: Acme

Responses

201

Created

application/json

Schema

Schema

data object
Brand data
brandIdstringrequired
Unique identifier of the brand
Example: brand_1
descriptionstring
Brand description
Example: Modern Menswear
namestringrequired
Brand name
Example: Acme

Example (auto)

{
  "data": {
    "brandId": "brand_1",
    "description": "Modern Menswear",
    "name": "Acme"
  }
}

400

Bad request

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Bad Request

Example (auto)

{
  "errorCode": "Generic",
  "message": "Bad Request"
}

401

Unauthorized

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Cannot retrieve session data because of expired token

Example (auto)

{
  "errorCode": "Generic",
  "message": "Cannot retrieve session data because of expired token"
}

422

Validation Error

application/json

Schema

Schema

errorCodestring
Example: Generic
errorsobject
Example: {"type":["Input type is not valid"]}
messagestring
Example: Validation error

Example (auto)

{
  "errorCode": "Generic",
  "errors": {
    "type": [
      "Input type is not valid"
    ]
  },
  "message": "Validation error"
}

429

Rate-limiting Error

application/json

Schema

Schema

errorCodestring
Example: Generic
messagestring
Example: Too many requests

Example (auto)

{
  "errorCode": "Generic",
  "message": "Too many requests"
}

500

Internal Error

application/json

Schema

Schema

errorCodestring
Example: Generic
errorsobject
Example: {"system":["Internal error detail message"]}
messagestring
Example: Internal server error

Example (auto)

{
  "errorCode": "Generic",
  "errors": {
    "system": [
      "Internal error detail message"
    ]
  },
  "message": "Internal server error"
}

Authorization: apiKey

name: apiKeytype: apiKeyin: header

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://sight.inspectorio.com/api/v1/brands' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'apiKey: <apiKey>' \
-d '{
  "brandId": "brand_1",
  "description": "Modern Menswear",
  "name": "Acme"
}'

Request Collapse all

Base URL

https://sight.inspectorio.com

Auth

ApiKeyAuth

Body

{
  "brandId": "brand_1",
  "description": "Modern Menswear",
  "name": "Acme"
}

ResponseClear

Click the Send API Request button above and see the response here!