Skip to content
UltimateTeam.ai Docs

Update Definition

PUT
/api/v1/workflows/definitions/{definition_id}
curl --request PUT \
  --url https://api.ultimateteam.ai/api/v1/workflows/definitions/example \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "category": "example", "definition": {}, "description": "example", "icon": "example", "layout": {}, "name": "example" }'

Update a workflow definition.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
definition_id
required
Definition Id
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
UpdateDefinitionRequest

Request body for updating a workflow definition.

All fields are optional – only provided fields are updated.

Attributes: name: Updated display name. description: Updated description. definition: Updated WorkflowDefinition dict. layout: Updated visual builder layout metadata. category: Updated category. icon: Updated icon identifier.

object
category
Any of:
string
definition
Any of:
object
key
additional properties
any
description
Any of:
string
icon
Any of:
string
layout
Any of:
object
key
additional properties
any
name
Any of:
string
Examplegenerated
{
  "category": "example",
  "definition": {},
  "description": "example",
  "icon": "example",
  "layout": {},
  "name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Update Definition Api V1 Workflows Definitions Definition Id Put
object
key
additional properties
any
Examplegenerated
{}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}