API Reference

Update workflow by external ID

patch
https://api.joinpopp.com/v1/workflows/by-external-id/

Updates the working draft of a workflow looked up by its caller-supplied external ID. At least one field must be provided.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 256
^[\w.-]+$

Caller-supplied external identifier matching ^[\w.-]+$ (1-256 characters).

Body Params

Update workflow request

Input for updating an existing workflow. At least one field must be provided. Updates apply to the working draft; existing in-flight runs continue to use the published version they started against.

string
length ≥ 1

Updated workflow name.

string

Updated description.

string

Updated JSON-encoded workflow graph. See the Workflow Configuration guide for the schema.

string

Updated JSON-encoded workflow settings.

string
length between 1 and 256
^[\w.-]+$

Updated caller-supplied identifier. Must be unique within your organization.

Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?