Create Category Image

Create a *Category Image*. **Required Fields** - image_file: Form posts are the only accepted upload option. Only one image at a time can be created. Supported file types are `JPEG/JPG`, `GIF`, `PNG` and `ICO`. Limit image size to `8MB`. To update a *Category Image*, use the [Update categories](/developer/api-reference/rest/admin/catalog/category-trees/categories#update-categories) endpoint and an `image_url`.

Authentication

X-Auth-Tokenstring
### OAuth scopes | UI Name | Permission | Parameter | |:--------|:-----------|:----------| | Products | modify | `store_v2_products` | | Products | read-only | `store_v2_products_read_only` | ### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Auth-Token` | `access_token` | For more about API accounts that generate `access_token`s, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

category_idstringRequired

Request

This endpoint expects a multipart form containing an optional file.
image_filefileOptional

Response

dataobject
metaobject
Response metadata.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error