Flow Steps

Order

post

Order for order.

Authorizations

ApiKeyAuth

Path parameters

flowStepstringRequired

The flowStep identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-steps/{flowStep}/routes/order

HTTPcURLJavaScriptPython

POST /api/v1/flow-steps/{flowStep}/routes/order HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Index

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• flowStep

• flowStep_count

• flowStepExists

• filters

• filters_count

• filtersExists

• firstStep

• firstStep_count

• firstStepExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• name

• step_id

Authorizations

ApiKeyAuth

Path parameters

flow_stepstringRequired

The flow step identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-steps/{flow_step}/routes

HTTPcURLJavaScriptPython

GET /api/v1/flow-steps/{flow_step}/routes HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "first_step_id": 1,
      "filter_logic_operator": "example_filter_logic_operator",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_version_id": 1,
      "name": "My Example",
      "microservice": {},
      "config": {},
      "parent_id": 1,
      "flow_version": {},
      "children": {},
      "endpoint": {},
      "connector": [],
      "data_pool": [],
      "filters": [],
      "parent_flow_step": [],
      "routes": [],
      "variables": [],
      "script_version": [],
      "cache": [],
      "payloads": [],
      "flow": {},
      "cross_references": "example_cross_references",
      "notes_count": 5,
      "notification_group": {},
      "order": "example_order"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/flow-steps/{flow_step}/routes",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/flow-steps/{flow_step}/routes?page=1",
    "last": "https://api.example.com/api/v1/flow-steps/{flow_step}/routes?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string	☑
first_step_id
filter_logic_operator	string

Authorizations

ApiKeyAuth

Path parameters

flow_stepstringRequired

The flow step identifier.

Body

application/json

first_step_idstring · nullableOptional

filter_logic_operatorstringOptional

namestring · min: 1 · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-steps/{flow_step}/routes

HTTPcURLJavaScriptPython

POST /api/v1/flow-steps/{flow_step}/routes HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "first_step_id": 1,
  "filter_logic_operator": "example_filter_logic_operator",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "first_step_id": 1,
    "filter_logic_operator": "example_filter_logic_operator",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_version_id": 1,
    "name": "My Example",
    "microservice": {},
    "config": {},
    "parent_id": 1,
    "flow_version": {},
    "children": {},
    "endpoint": {},
    "connector": [],
    "data_pool": [],
    "filters": [],
    "parent_flow_step": [],
    "routes": [],
    "variables": [],
    "script_version": [],
    "cache": [],
    "payloads": [],
    "flow": {},
    "cross_references": "example_cross_references",
    "notes_count": 5,
    "notification_group": {},
    "order": "example_order"
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string
first_step_id
filter_logic_operator	string

Authorizations

ApiKeyAuth

Path parameters

flow_stepstringRequired

The flow step identifier.

routestringRequired

The route identifier.

Body

application/json

first_step_idstring · nullableOptional

filter_logic_operatorstringOptional

namestring · min: 1 · max: 255Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-steps/{flow_step}/routes/{route}

HTTPcURLJavaScriptPython

PUT /api/v1/flow-steps/{flow_step}/routes/{route} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "first_step_id": 1,
  "filter_logic_operator": "example_filter_logic_operator",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "first_step_id": 1,
    "filter_logic_operator": "example_filter_logic_operator",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "flow_version_id": 1,
    "name": "My Example",
    "microservice": {},
    "config": {},
    "parent_id": 1,
    "flow_version": {},
    "children": {},
    "endpoint": {},
    "connector": [],
    "data_pool": [],
    "filters": [],
    "parent_flow_step": [],
    "routes": [],
    "variables": [],
    "script_version": [],
    "cache": [],
    "payloads": [],
    "flow": {},
    "cross_references": "example_cross_references",
    "notes_count": 5,
    "notification_group": {},
    "order": "example_order"
  }
}

Destroy

delete

Delete a route.

Authorizations

ApiKeyAuth

Path parameters

flow_stepstringRequired

The flow step identifier.

routestringRequired

The route identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-steps/{flow_step}/routes/{route}

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-steps/{flow_step}/routes/{route} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}