Workflows

Update workflow metadata

put/v4/workflows/{workflowId}/metadata

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/metadata
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

ID of the workflow to update

Request body

urlsstring[]

List of target URLs for the workflow

limitinteger nullable

Maximum records per run. Pass null to clear the limit and extract all rows.

updateInterval'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' | 'CUSTOM'

The new update interval for the workflow

schedulesstring[]

Array of cron expressions for the workflow schedule

timezonestring

IANA timezone for cron schedules. A timezone-only update preserves existing cron expressions.

namestring

The new name for the workflow

descriptionstring

The new description for the workflow

tagsstring[]

The tags for the workflow

entitystring

The new entity for the workflow

additionalDataobject

Additional static data for the workflow

userPromptstring

Natural language instructions for the workflow.

Example request

{
  "timezone": "America/New_York",
  "tags": [
    "tag1",
    "tag2"
  ],
  "entity": "job_posting"
}

Response

Workflow metadata updated successfully

successboolean
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.