Create or update org custom attributes

PUT

/api/v1/extraction/attributes/{domain}

curl --request PUT \
  --url https://dashboard.justcrawl.io/api/v1/extraction/attributes/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "pageType": "example", "attributes": [ { "name": "example", "xpaths": [ "example" ], "type": "text", "description": "example", "antiPatterns": [ "example" ], "semanticType": "brand_name", "validation": { "minLength": 1, "maxLength": 1, "min": 1, "max": 1, "pattern": "example" } } ] }'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

domain

required

string

Request Body ^required

Media type application/json

object

pageType

required

string

attributes

required

Array<object>

object

name

required

string

xpaths

required

Array<string>

type

required

string

Allowed values: text number url boolean text[] url[]

description

string

nullable

antiPatterns

Array<string>

nullable

semanticType

string

nullable

Allowed values: brand_name review_count product_id product_image star_rating

validation

object

minLength

integer

maxLength

integer

min

number

max

number

pattern

string

Responses

200

Updated org attributes

Media type application/json

Org-scoped custom attributes. When no row exists, the API returns { attributes: [] } and other fields are omitted.

object

id

string format: uuid

orgId

string format: uuid

domain

string

pageType

string

attributes

required

Array<object>

object

name

required

string

xpaths

required

Array<string>

type

required

string

Allowed values: text number url boolean text[] url[]

description

string

nullable

antiPatterns

Array<string>

nullable

semanticType

string

nullable

Allowed values: brand_name review_count product_id product_image star_rating

validation

object

minLength

integer

maxLength

integer

min

number

max

number

pattern

string

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "attributes": [
    {
      "type": "text",
      "semanticType": "brand_name"
    }
  ]
}

400

Validation error