Access Policy API5

Access Policy Approval Procedure API5

Access Profile API5

Access Relationship API5

Access Request API6

App Instance API6

App Resource API8

App Resource Role API7

Approval Delegation API5

Approval Request API5

Audit Log API1

Auth API1

Custom Field API1

Custom Service API5

Entity API8

Entity Field Mapping API6

Entity Ingestion Config API8

Entity Type API13

Folder API7

Group API5

Guidance API6

Journey API2

Schedule API2

SLA API5

Tag API8

Team API5

Team User API5

Ticket API31

Topic API1

User API6

User Relationship API2

Workflow API7

Workflow Approval Procedure API5

Workflow Run API5

Workflow API

Update Workflow

Update an existing workflow.

put/v2/workflows/{id}

Request

Base URL
https://public.api.serval.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/serval/apis/serval-public-api/docs/v2/workflows/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The ID of the workflow.

Request body

namestring

The name of the workflow.

descriptionstring

A description of the workflow.

requireFormConfirmationboolean nullable

Whether the workflow requires form confirmation. Omit to leave unchanged.

contentstring

The content/code of the workflow.

isPublishedboolean nullable

Whether the workflow is published. Set to true to publish the workflow.

showInServiceCatalogboolean nullable

Whether to list this workflow in the Service Catalog. Omit to leave unchanged.

serviceCatalogDescriptionstring nullable

Description shown at the top of the Service Catalog run form. Omit to leave unchanged; send an empty string to clear it.

Response

Success

Changes

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