Canvas Steps

Get Graph

get

Retrieves the graph for a given flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/graph

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/graph HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create Flow Version Graph Step

post

Creates a new step on the canvas for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/graph/steps

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/graph/steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Flow Version Graph Steps

delete

Permanently deletes all steps from the canvas for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/graph/steps

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-versions/{flow_version}/graph/steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Flow Version Graph Step

get

Retrieves the details of a specific canvas step for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/graph/steps/{step}

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/graph/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Flow Version Graph Step

delete

Permanently deletes a specific canvas step for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

stepstringRequired

The step identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/graph/steps/{step}

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-versions/{flow_version}/graph/steps/{step} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Paste Steps

post

Pastes copied steps onto the canvas for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/graph/paste-steps

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/graph/paste-steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content