Update Workflow - Serval Documentation

PUT

workflows

{id}

Update Workflow

curl --request PUT \
  --url https://public.api.serval.com/v2/workflows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
  "requireFormConfirmation": true,
  "content": "<string>",
  "isPublished": true
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
    "requireFormConfirmation": true,
    "content": "<string>",
    "isPublished": true,
    "hasUnpublishedChanges": true,
    "tagIds": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

The ID of the workflow.

Body

application/json

name

string

The name of the workflow.

description

string

A description of the workflow.

executionScope

enum<string>

The execution scope of the workflow.

Available options:

WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED,

TEAM_PRIVATE,

TEAM_PUBLIC

requireFormConfirmation

boolean

Whether the workflow requires form confirmation.

content

string

The content/code of the workflow.

isPublished

boolean | null

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

Response

Success

data

data · object

The updated workflow.

Show child attributes

Update Workflow

curl --request PUT \
  --url https://public.api.serval.com/v2/workflows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
  "requireFormConfirmation": true,
  "content": "<string>",
  "isPublished": true
}
'

{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
    "requireFormConfirmation": true,
    "content": "<string>",
    "isPublished": true,
    "hasUnpublishedChanges": true,
    "tagIds": [
      "<string>"
    ]
  }
}