---
updatedAt: 2025-06-05T21:05:13.000Z
agentTools:
  projectIndex: https://developers.goformz.com/llms.txt
---

# Sketch Field

The Sketch Field captures sketch data with the following properties:

* `background` - A photo or image that represents the background of the drawing.
* `drawing` - An image that represents the drawing on top of the `background` image.

```json
{
 "Sketch 1": {
      "background": null,
      "drawing": {
        "id": "770486b6-39ed-4965-9766-7037416a7162",
        "link": "https://api.goformz.com/v2/files/770486b6-39ed-4965-9766-7037416a7162"
      },
      "raw": "{\"objects\":[ ... ]}", //omitted for brevity
      "version": 2,
      "id": "d61bfeeb-9db6-499d-8dec-a46c0108d3ca",
      "name": "Sketch 1",
      "type": "Sketch"
    } 
}
```

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

The `background` and `drawing` properties are `File` property types and each have the following properties:

* `id` - The `id` of an image uploaded to the `Files` endpoint.
* `link` - A downloadable `link` to that image or photo's location in storage.

> 📘 NOTE:
>
> The `link` property is read-only and will not be persisted if it is updated.

The `background` file and the `drawing` file require uploading a `File` first and then assigning that uploaded file's `id` to that property's `id` property.  For more details see the section: "[Uploading a file](https://developers.goformz.com/docs/uploading-a-file)".