Images are not independent records. Rather, they are properties of sites, customers, staff, companies, categories and products.

There is no explicit GET action for images. To download image data, GET the URL assigned to the image property of the related record.

Direct Assignment

The simplest way to add an image to a record is to assign a URL of an image hosted on a third-party server:

PUT /v1/companies/5678/staff/5 Update a staff member

Delete an image

  • When updating a record with an image, setting its image property to null will delete it.