Skip to main content
PUT
/
v2
/
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>",
  "type": "WORKFLOW_TYPE_UNSPECIFIED",
  "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
  "requireFormConfirmation": true,
  "isTemporary": true,
  "content": "<string>",
  "parameters": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "teamId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "type": "WORKFLOW_TYPE_UNSPECIFIED",
    "executionScope": "WORKFLOW_EXECUTION_SCOPE_UNSPECIFIED",
    "requireFormConfirmation": true,
    "isTemporary": true,
    "content": "<string>",
    "parameters": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

The ID of the workflow.

Body

application/json
​
name
string

The name of the workflow.

​
description
string

A description of the workflow.

​
type
enum<string>

The type of the workflow.

Available options:
WORKFLOW_TYPE_UNSPECIFIED,
EXECUTABLE,
GUIDANCE
​
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.

​
isTemporary
boolean

Whether the workflow is temporary.

​
content
string

The content/code of the workflow.

​
parameters
string

The parameters schema of the workflow (JSON).

Response

Success

​
data
data · object

The updated workflow.