Hey Mark,

Here's another example with more comments. The template is simply the name of the template. It will automatically assign all of the fields that belong to the template to the entry.

We expose the fields section if you wanted to also set some of the field values (or for instance, if you have a Required field in the template, you would have to set the value at this time). The more complicated structure is the set of fields, which is a dictionary of the fields that you want to set values for.

{
    "template" : "Email", //the name of the template
    "metadata" : {
        "fields" : {
            "Subject" : { //the key to this dictionary is the name of the field. In this case, the field named "Subject"
                "values" : [
                    {
                    "value" : "Hello",
                    "position" : 1 //Currently it is required to set the position (which is 1-indexed) even for a field that isn't a multi-value field
                    }
                ]
            },
			"Sender" : { //the key to this dictionary is the name of the field. In this case, the field named "Sender"
                "values" : [
                    {
                    "value" : "sender@email.com",
                    "position" : 1 
                    }
                ]
            },
			"Recipients" : { //the key to this dictionary is the name of the field. In this case, the field named "Recipients"
                "values" : [
                    {
                    "value" : "recipient1@email.com",
                    "position" : 1 
                    },
                    {
                    "value" : "recipient2@email.com", 
                    "position" : 2  //This is a multi-value field, so we can set multiple values using different position values
                    }
                ]
            }
        }
    }
}

We're experimenting with different tools to generate our reference material so your feedback is greatly appreciated. It also looks like we may want to rethink how these fields are set up. A list of field dictionaries would make more sense, and position should maybe only be required for multi value fields.

Alex,

Thanks for the feedback / update - keep those dribs and drabs coming!

Yes, I agree that the having the position optional for single valued fields would make more sense.  In the context of single valued fields, will the json entry STILL be an array, or will it change?

e.g. from your example, with field "recipient" having a single value of  "recipient1@email.com"