> For the complete documentation index, see [llms.txt](https://apidocs.zerionsoftware.com/doc/iformbuilder-v80/llms.txt)

# Upload Branding Image

> POST /branding/images/{name}
> 
> Replaces one of the server's branding images. The upload is resized to the image's fixed size, ignoring its aspect ratio, and stored at `[servername]/[name].png` in the server's branding bucket, public-read. The console pages and devices read that object directly, so it is the image they show from then on.
> 
> | name | size (px) |
> |---|---|
> | `sign_in` | 70 x 28 |
> | `content` | 800 x 600 |
> | `header_bg` | 65 x 85 |
> | `login_bg` | 439 x 325 |
> | `dataview_login` | 350 x 33 |
> | `login` | 109 x 38 |
> | `logo` | 248 x 58 |
> | `pw_reset_header` | 350 x 33 |
> | `reset_password` | 168 x 38 |
> | `formbuilder_logo` | 355 x 70 |
> | `formbuilder_sidebar` | 70 x 560 |
> | `logout` | 70 x 28 |
> | `activate` | 168 x 38 |
> | `web_page_icon` | 32 x 32 |
> | `sso_login_bg` | 878 x 325 |
> | `sso_dataview_login` | 350 x 33 |
> | `sso_login` | 109 x 38 |
> 
> The three `sso_*` names exist only while SSO is enabled on the server.
> 
> ### Authorization
> 
> Internal API clients only, and SERVER users only, whatever the server's ZWS mode.



## Servers
- https://api.iformbuilder.com/exzact/api/v80/[servername]: https://api.iformbuilder.com/exzact/api/v80/[servername]


## Authentication methods
- Oauth2


## Parameters
### Headers

- **Authorization** (string)
  e.g. Bearer {access_token}


### Path parameters

- **name** (string)
  the image name; see the table above



### Body: multipart/form-data (object)

- **file** (string(binary))
  one PNG image; its bytes are checked, not its file name or declared type



## Responses
### 201
Created - the image was stored.

#### Body: application/json (object)
- **name** (string)
  the image name from the path

- **url** (string)
  the public URL of the stored image


### 400
Bad Request - no file was uploaded, or the file is not a PNG image GD can read.

#### Body: application/json (object)
- **error_message** (string)
  human-readable reason for the failure


### 401
Unauthorized - missing or invalid bearer token.

#### Body: application/json (object)
- **error_message** (string)
  human-readable reason for the failure


### 403
Forbidden - the client is not internal, or the user is not a SERVER user.

#### Body: application/json (object)
- **error_message** (string)
  human-readable reason for the failure


### 404
Not Found - `name` is not an image name, or is an `sso_*` name while SSO is off.

#### Body: application/json (object)
- **error_message** (string)
  human-readable reason for the failure


### 502
Bad Gateway - the image could not be written to the branding bucket.

#### Body: application/json (object)
- **error_message** (string)
  human-readable reason for the failure



[Powered by Bump.sh](https://bump.sh)
