Property Reference

This reference guide gives you a list of each property available on each element overridable via the API.

Properties are specified in the `elements` object, either at the template level, or at a size-specific level. This gives you the flexibility to override values from your template on all sizes that you specify in the request, or at specific sizes, or a combination of both.

Request

Text

Image

Rectangle

Examples

{
    "template": "my-template",
    "sizes": [
        {
            "width": 1920,
            "height": 1080
        },
        {
            "width": 1080,
            "height": 1080
        }
    ],
    "elements": {
        "text1": {
            "text": "Both sizes will have this text!"
        }
    }
}

{
    "template": "my-template",
    "sizes": [
        {
            "width": 1920,
            "height": 1080,
            "elements": {
                "text1": {
                    "text": "This image will be 1920x1080"
                }
            }
        },
        {
            "width": 1080,
            "height": 1080,
            "elements": {
                "text1": {
                    "text": "And this image will be 1080x1080"
                }
            }
        }
    ]
}

{
    "template": "my-template",
    "sizes": [
        {
            "width": 1920,
            "height": 1080,
            "elements": {
                "text1": {
                    "text": "Overriding the text on this 1920x1080 image"
                }
            }
        },
        {
            "width": 1080,
            "height": 1080,
            "elements": {
                "text1": {
                    "text": "And this square has a different background image!"
                },
                "background": {
                    "url": "https://www.somewhere.com/nice-image.png"
                }
            }
        },
        {
            "width": 1080,
            "height": 1920,
            "elements": {
                "background": {
                    "opacity": 0.5
                }
            }
        }
    ],
    "elements": {
        "text1": {
            "text": "Setting some default text here"
        }
    }
}