Skip to content
Docs
Select language:English

/api/v1/accounts/{accountId}/brands (POST)

POST
/api/v1/accounts/{accountId}/brands
curl --request POST \
  --url https://example.com/api/v1/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/brands \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "website": "example", "supportPhone": "example", "claimUrl": "example", "defaultWarrantyMonths": 1 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
accountId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
>= 1 characters <= 120 characters
website
Any of:
string
<= 2000 characters
supportPhone
Any of:
string
<= 40 characters
claimUrl
Any of:
string
<= 2000 characters
defaultWarrantyMonths
Any of:
integer
<= 1200
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "name": "example",
  "website": "example",
  "supportPhone": "example",
  "claimUrl": "example",
  "defaultWarrantyMonths": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Default Response

Media typeapplication/json
object
item
required
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
rowVersion
required
integer
>= -9007199254740991 <= 9007199254740991
ownerAccountId
required
Any of:
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
website
required
string | null
supportPhone
required
string | null
claimUrl
required
string | null
defaultWarrantyMonths
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
hasLogo
boolean
possibleDuplicates
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
name
required
string
similarity
required
number
Examplegenerated
{
  "item": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "rowVersion": 1,
    "ownerAccountId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "website": "example",
    "supportPhone": "example",
    "claimUrl": "example",
    "defaultWarrantyMonths": 1,
    "hasLogo": true
  },
  "possibleDuplicates": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "similarity": 1
    }
  ]
}