Skip to content

Custom Field Samples

To populate a custom field called "A Sample Field, with the value of "testing", you would include the following XML in your POST.

    <custom_fields type="array">
        <custom_field>
            <name>A Sample Field</name>
            <value>testing</value>
        </custom_field>
    </custom_fields>

Populating custom field values works the same way regardless of type or permission. The type of field and the field permission will be inherited from the template.

To replicate the example above, but as a multi value pick list, you would include the following XML within the custom fields array on the job:

    <custom_field>
        <name>A Sample Field</name>
        <values type="array">
            <value>testing 1</value>
            <value>testing 2</value>
        </values>        
    </custom_field>

To create a populated location custom field, you would include the following XML within the custom fields array on the job:

<custom_field>
    <name>Location of Damaged Equipment</name>
    <lat>-36.849919</lat>
    <lng>174.7624623</lng>
    <formatted_address>34893 Albert Street, Auckland CBD, Auckland 1010, New Zealand</formatted_address>
</custom_field>

Supplying values for images, or signatures is not currently supported.