API Reference
  1. Workflow Instance API
  2. Workflows

Update Workflow

put
https://tst-api.broadridge.com/workflows
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Same workflow command payload as Create Workflow. The identifier for an update is supplied in the required Workflow-Id request header.

string
required

The name of the workflow definition being executed.

string

Workflow-defined step or state to which the workflow has transitioned.

string
required

The step within the workflow instance that needs to be executed.

string
required

The content or payload type needed to perform the task.

identifiers
array of objects

Type-value pairs used to look up and uniquely identify the workflow.

identifiers
narratives
array of objects

Descriptive information about the workflow.

narratives
dates
array of objects

Important dates pertinent to the workflow being executed.

dates
references
array of objects

Reference data that enables customized UI displays.

references
accounts
array of objects

Business model array. Reference: https://developer-api.broadridge.com/party-account/reference/create-account-1

accounts
balances
array of objects

Business model array. Reference: https://developer-api.broadridge.com/balance/reference/list-balances-1

balances
calendars
array of objects

Business model array. Reference: https://developer-api.broadridge.com/calendar/reference/list-calendar-records

calendars
corporateActionAnnouncements
array of objects

Business model array. Reference: https://developer-api.broadridge.com/corporate-actions/reference/list-announcements

corporateActionAnnouncements
corporateActionPreferences
array of objects

Business model array. Reference: https://developer-api.broadridge.com/corporate-actions/reference/list-preferences

corporateActionPreferences
fxRates
array of objects

Business model array. No reference URL has been provided.

fxRates
instruments
array of objects

Business model array. Reference: https://developer-api.broadridge.com/instrument/reference/list-instruments

instruments
instructions
array of objects

Business model array. Reference: https://developer-api.broadridge.com/instruction/reference/create-instructions

instructions
moneyMovements
array of objects

Business model array. Reference: https://developer-api.broadridge.com/money-movement/reference/list-money-movements-1

moneyMovements
orders
array of objects

Business model array. Reference: https://developer-api.broadridge.com/order/reference/list-orders

orders
parties
array of objects

Business model array. Reference: https://developer-api.broadridge.com/party-account/reference/create-party-1

parties
positions
array of objects

Business model array. Reference: https://developer-api.broadridge.com/position/reference/list-positions

positions
prices
array of objects

Business model array. Reference: https://developer-api.broadridge.com/price-management/reference/list-prices

prices
productCatalogs
array of objects

Business model array. Reference: https://developer-api.broadridge.com/product-catalog/reference/search-product-catalog

productCatalogs
productSubscriptions
array of objects

Business model array. Reference: https://developer-api.broadridge.com/product-catalog/reference/search-subscriptions

productSubscriptions
proxyAccounts
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-accounts

proxyAccounts
proxyAgendas
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-agendas-1

proxyAgendas
proxyBallots
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-ballots-1

proxyBallots
proxyEvents
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-events-1

proxyEvents
proxyGroups
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-proxygroups

proxyGroups
proxyNotifications
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-notifications

proxyNotifications
proxyPolicies
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/policydetails-1

proxyPolicies
proxyVoteInstructions
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-voteinstructions

proxyVoteInstructions
proxyVoteOutputs
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-voteoutputs-1

proxyVoteOutputs
proxyVotes
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/create-vote-1

proxyVotes
proxyVotingPreferences
array of objects

Business model array. Reference: https://developer-api.broadridge.com/proxy/reference/list-voting-preferences

proxyVotingPreferences
settlementConfirmations
array of objects

Business model array. Reference: https://developer-api.broadridge.com/settlement/reference/create-settlement-confirmations

settlementConfirmations
settlementObligations
array of objects

Business model array. Reference: https://developer-api.broadridge.com/settlement/reference/get-settlement-obligations-by-id

settlementObligations
taxForms
array of objects

Business model array. Reference: https://developer-api.broadridge.com/tax/reference/list-tax-forms

taxForms
taxLots
array of objects

Business model array. Reference: https://developer-api.broadridge.com/tax/reference/list-tax-lots

taxLots
transactions
array of objects

Business model array. Reference: https://developer-api.broadridge.com/trade/reference/list-trades-1

transactions
transfers
array of objects

Business model array. Reference: https://developer-api.broadridge.com/transfer/reference/create-transfer

transfers
Headers
string
required

Alpha-numeric unique client ID assigned by Broadridge.

date-time
required
^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.000Z$

UTC timestamp when the client initiated this request. Each API invocation must use a new value.

uuid
required

Client-generated UUID for this API invocation. Broadridge uses it to recognize retries of the same request and safely support idempotency.

string
required

Unique ID used to track the end-to-end flow of API invocations in a logical sequence of events.

uuid
required

Identifier for the workflow associated with this update request. Broadridge recommends a version 4 UUID.

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?