Skip to main content
PUT
/
v4
/
workflows
/
{workflowId}
/
metadata
Update workflow metadata
curl --request PUT \
  --url https://api.kadoa.com/v4/workflows/{workflowId}/metadata \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "urls": [
    "<string>"
  ],
  "limit": 123,
  "updateInterval": "ONLY_ONCE",
  "schedules": [
    "<string>"
  ],
  "name": "<string>",
  "description": "<string>",
  "tags": [
    "tag1",
    "tag2"
  ],
  "location": {
    "type": "auto",
    "isoCode": "<string>"
  },
  "monitoring": {
    "enabled": true,
    "fields": [
      {
        "fieldName": "<string>",
        "operator": "changed"
      }
    ],
    "conditions": {
      "logicalOperator": "AND",
      "conditions": [
        {
          "type": "SINGLE",
          "field": "<string>",
          "operator": "<string>",
          "value": "<string>"
        }
      ]
    }
  },
  "entity": "job_posting",
  "schema": [
    {
      "name": "<string>",
      "description": "<string>",
      "example": "<string>",
      "dataType": "STRING",
      "isPrimaryKey": true,
      "isRequired": true,
      "isUnique": true
    }
  ],
  "dataLinking": {
    "enabled": true
  },
  "additionalData": {},
  "maxPages": 50000,
  "maxDepth": 100,
  "pathsFilterIn": [
    "<string>"
  ],
  "pathsFilterOut": [
    "<string>"
  ]
}'
{
  "success": true,
  "message": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
workflowId
string
required

ID of the workflow to update

Body

application/json
​
urls
string[]

List of target URLs for the workflow

​
limit
integer

The new limit for the workflow

​
updateInterval
enum<string>

The new update interval for the workflow

Available options:
ONLY_ONCE,
HOURLY,
DAILY,
WEEKLY,
MONTHLY,
CUSTOM
​
schedules
string[]

Array of cron expressions for the workflow schedule

​
name
string

The new name for the workflow

​
description
string

The new description for the workflow

​
tags
string[]

The tags for the workflow

Example:
["tag1", "tag2"]
​
location
object

The new location for the workflow

​
monitoring
object

The new monitoring config for the workflow

​
entity
string

The new entity for the workflow

Example:

"job_posting"

​
schema
object[]

The new extraction schema for the workflow

​
dataLinking
object

Data linking configuration for the workflow

​
additionalData
object

Additional static data for the workflow

​
maxPages
integer

Maximum pages to crawl (only for crawler workflows)

Required range: 1 <= x <= 100000
​
maxDepth
integer

Maximum crawl depth (only for crawler workflows)

Required range: 1 <= x <= 200
​
pathsFilterIn
string[]

Regex patterns to include specific paths (only for crawler workflows)

​
pathsFilterOut
string[]

Regex patterns to exclude specific paths (only for crawler workflows)

Response

Workflow metadata updated successfully

​
success
boolean
​
message
string