Turn enrichment on or off for an attribute
The one field worth changing on its own: it decides whether the next enrichment run may write this attribute, and therefore what a run costs.
Authorization
apiKey Your API key. X-Api-Key: <key> is accepted as an alternative.
A key belongs to an organization, not a user, so it outlives whoever created it. It carries two independent things, and both are checked: an org role (a member key cannot approve a publish or activate a mapping) and a set of scopes — catalog:read, catalog:write, enrichment:write, publishing:read, publishing:write, org:read, org:write. Holding a scope does not grant a role, and holding a role does not grant a scope.
GET /v1/me returns both for the key you are holding.
In: header
Path Parameters
The brand to read.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X PATCH "https://example.com/v1/brands/string/attributes/string/extract" \ -H "Content-Type: application/json" \ -d '{ "extract": true }'{ "extract": true, "id": "string"}Update an attribute definition PUT
Replaces the editable fields. The `key` is not among them — every existing value joins on it, so re-keying would orphan the column.
Start a run POST
A batch of product identities in, a run id back. **202, not 200**: the work has been accepted, not done — poll `GET /runs/{id}`. Needs `catalog:write` and an `Idempotency-Key` header: a retried POST with the same key does not scrape the batch twice. Send NDJSON (one object per line, `application/x-ndjson`) or a JSON array. Lines are accepted or rejected **individually**: a batch of 5,000 with one bad row scrapes 4,999 and tells you which line failed. Every line needs a vendor SKU (`sku` or `vendorSku`) — it is what the supplier's site is indexed by, and a line without one is rejected. Each line needs something to scrape *against*: either a `categoryId` whose category has a golden mapping, or its own `attributes`. A line with neither is refused as `no_gold_match` rather than scraped for generic attributes.