The Image Field is responsible for storing a path to an uploaded image. The property imageFile is a File property type and has the following properties:

  • id - The id to a uploaded file to the Files endpoint.
  • link - A downloadable link to that file's location in storage.

📘

NOTE:

The link property is read-only and will not be persisted if it is updated.

{
    "Image": {
      "imageFile": {
        "id": "58078f6c-964c-4b27-96b5-a46c01094f2b",
        "link": "https://api.goformz.com/v2/files/58078f6c-964c-4b27-96b5-a46c01094f2b"
      },
      "id": "fbbd61f4-fbb8-4fb4-8207-a46c0108d3ca",
      "name": "Image",
      "type": "Image"
    }
}

📘

NOTE:

The id, name, and type are not necessary when setting or updating the Image Field. These properties are returned in the JSON of the request for readability.

The Image Field requires uploading a File first and then assigning that uploaded file's id with the imageFile > id property. For more details see the section: "Uploading a file".