Skip to main content
Python
import requests

url = 'https://api.simplex.sh/update_workflow_metadata'
headers = {
    'Authorization': 'Bearer your_api_key_here'
}
data = {
    'workflow_id': 'your_workflow_id_here',
    'metadata': 'production'
}

response = requests.post(url, headers=headers, data=data)
result = response.json()
if result['succeeded']:
    print(f"Metadata updated for workflow {result['workflow_id']}")
    print(f"New metadata: {result['metadata']}")
{
  "succeeded": true,
  "message": "<string>",
  "workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}
Updates the metadata for a specific workflow. The metadata is stored as a string and can be used to tag or categorize workflows.

Authorizations

​
X-API-Key
string
header
required

Simplex API Key

Body

application/json
​
workflow_id
string<uuid>
required

The ID of the workflow to update.

​
metadata
string
required

The metadata string to set for the workflow.

Response

Update workflow metadata response

​
succeeded
boolean
required

Whether the update was successful.

​
message
string

Success message.

​
workflow_id
string<uuid>

The ID of the updated workflow.

​
metadata
string

The new metadata value.