Create Custom URL Classification

Define a new custom URL classification for a project. Once created, it can be assigned to URLs via the assignment endpoint.

POST /classifications/urls

Create Custom URL Classification

cURL

curl --request POST \
  --url https://api.peec.ai/customer/v1/classifications/urls \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb",
  "color": "orange"
}
'

201

{
  "name": "<string>",
  "color": "<string>"
}

Authorizations

APIKeyHeaderAPIKeyQuery

X-API-Key · string · header · required

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

name · string · required

Required string length: 1 - 60

project_id · string

Required if using a company api key

Example:

"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"

color · enum<string> · default: orange

Available options: orange, red, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose, gray

Example:

"orange"

Response

201

application/json

Custom URL classification created

Custom URL classification created

name · string · required

color · string · required