Payload Variables

A payload variable is a name-value pair associated with a message instance. It can be substituted into the final message text, saved to the database when a response is logged, used as the scope for duplicate message suppression, or used to process a response. For example:

[Product Id] = "12-E2345", [Product] = "Canon F150", [Account] = "Marriott HQ"

The payload property set is passed with the message to message display services and automated response services. The payload structure is a set of name-value pairs.

Any payload variable can be substituted into the text by enclosing its name in []. Any payload variable can be logged to the response table as long as a Response Field mapping is specified.

Payload variables are also used for message suppression. See About Suppressing Duplicate Messages.

You create payload variables using the Administration - Order Management screen, Message Types, and then the Payload view.