---
title: "Upload a gallery image to a product"
method: POST
path: "/companies/{company}/products/{product}/gallery"
tags: ["Products"]
---

# Upload a gallery image to a product

`POST /companies/{company}/products/{product}/gallery`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/products/{product}/gallery`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Attach an image (jpeg, png, jpg, gif or webp; up to 3 MB) to the product gallery. Returns the updated product. Fails with 422 if the gallery limit is exceeded.

## Path parameters

- `company` string, uuid, required
- `product` string, uuid, required

## Headers

- `Idempotency-Key` string, required
- `Factuarea-Version` string, date

## Response `201`

- object
  - `data` object, required
    - `object` 'product_image', required
    - `index` integer, required: Position (0-based) of the newly uploaded image in the gallery.
    - `url` string, uri, required: Public URL of the uploaded image.
    - `content_type` 'image/jpeg' | 'image/png' | 'image/gif' | 'image/webp' | 'application/octet-stream', required: MIME type of the image.
    - `gallery_total` integer, required: Total number of images in the gallery after the upload.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)