API Reference
Data PrivacyImprint

Create Workflow

post
https://sandbox.api.lemon.markets/v1/accounts//workflows
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

An account identifier.

Query Params
boolean
Defaults to false

Use new unified order API instead of the batch_order API.

Body Params

A request to create a workflow. The trigger and action types must be paired: a schedule trigger requires an order.create_and_confirm action, and a cash_deposited trigger requires an invest_with_allocations action. Any other combination is rejected with a 400.

trigger
required

A workflow trigger. This structure represents the way that the workflow is started. The type field selects the trigger:

  • schedule: starts the workflow on a recurring schedule.
  • cash_deposited: starts the workflow when cash is deposited into the customer account. It carries no further parameters: the arrival of the deposit is the trigger. Sending cadence, start_after, day_of_month or day_of_week with this trigger is rejected with a 400.
action
object
required

An object representing a workflow action. The nested object matching type is required: order for an order.create_and_confirm action, or invest_with_allocations for an invest_with_allocations action.

Headers
string
required
string
required
Responses

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?