Skip to main content
PUT
Update workflow metadata

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,
EVERY_10_MINUTES,
HALF_HOURLY,
HOURLY,
THREE_HOURLY,
SIX_HOURLY,
TWELVE_HOURLY,
EIGHTEEN_HOURLY,
DAILY,
TWO_DAY,
THREE_DAY,
WEEKLY,
BIWEEKLY,
TRIWEEKLY,
FOUR_WEEKS,
MONTHLY,
REAL_TIME,
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:
location
object

The new location for the workflow

monitoring
object

The 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

additionalData
object

Additional static data for the workflow

userPrompt
string

Natural language instructions for the workflow.

Required string length: 10 - 5000

Response

Workflow metadata updated successfully

success
boolean
message
string