Settings Area Labels

List Area Labels

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

List of area labels

application/json

totalRowsnumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

500

Unexpected error

application/json

get/settings/areaLabels

HTTPcURLJavaScriptPython

GET /v2/settings/areaLabels HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "rows": [
    {
      "id": "living-room",
      "label": "Living Room",
      "active": true,
      "quoteTypes": [
        "interior",
        "residential"
      ]
    }
  ]
}

Create Area Label

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

labelstringRequired

The display name of the area label.

activebooleanOptional

Whether this area label is active & usable

quoteTypesstring[]Optional

The quote types this area label applies to

Responses

200

Successfully created area label

application/json

idstringRequired

The unique ID of the area label.

labelstringRequired

The display name of the area label.

activebooleanOptional

Whether this area label is active & usable

quoteTypesstring[]Optional

The quote types this area label applies to

400

Bad Request

application/json

401

Not Authorized

application/json

409

Conflict - Area label already exists

application/json

500

Unexpected error

application/json

post/settings/areaLabels

HTTPcURLJavaScriptPython

POST /v2/settings/areaLabels HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "label": "Living Room",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

{
  "id": "living-room",
  "label": "Living Room",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Retrieve Area Label

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Area Label

Responses

200

Details about the area label

application/json

idstringRequired

The unique ID of the area label.

labelstringRequired

The display name of the area label.

activebooleanOptional

Whether this area label is active & usable

quoteTypesstring[]Optional

The quote types this area label applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/settings/areaLabels/{id}

HTTPcURLJavaScriptPython

GET /v2/settings/areaLabels/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "living-room",
  "label": "Living Room",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Update Area Label

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Area Label

Body

application/json

idstringRequired

The unique ID of the area label.

labelstringRequired

The display name of the area label.

activebooleanOptional

Whether this area label is active & usable

quoteTypesstring[]Optional

The quote types this area label applies to

Responses

200

Successfully updated area label

application/json

idstringRequired

The unique ID of the area label.

labelstringRequired

The display name of the area label.

activebooleanOptional

Whether this area label is active & usable

quoteTypesstring[]Optional

The quote types this area label applies to

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/settings/areaLabels/{id}

HTTPcURLJavaScriptPython

PUT /v2/settings/areaLabels/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 96

{
  "id": "living-room",
  "label": "Living Room",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

{
  "id": "living-room",
  "label": "Living Room",
  "active": true,
  "quoteTypes": [
    "interior",
    "residential"
  ]
}

Delete Area Label

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Area Label

Responses

204

Area label successfully deleted

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/settings/areaLabels/{id}

HTTPcURLJavaScriptPython

DELETE /v2/settings/areaLabels/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content