Input fields

collectionProcessNumber : String! required

The unique number of the collection process.
requiredChannel : CollectionProcessCommChannel

When supplied, the channel that the comms step must be dispatched on. Persisted on the first call; a repeat call with a different value is logged but the persisted value wins.
runAssessments : Boolean! required

Whether to run withdrawal and pause assessments just before sending.
stepIdentifier : String! required

The identifier for the specific communication step.
The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "collectionProcessNumber": "year-energy-ahead-perform-born", "requiredChannel": "EMAIL", "runAssessments": true, "stepIdentifier": "96608743" }