# Upload the customer portal background

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/setting/customer_portal_bg
```

- API version: v1
- Operation ID: `v1_public_setting_customer_portal_bg_update`
- Section: Team settings › [Company settings](https://developer.yoprint.com/reference/company-settings.md)
- Web page: https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-bg-update/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Uploads the background image of your customer portal as `multipart/form-data`, in the field `media`. It replaces the current one.

The file is checked first, so a refused upload leaves the current background in place. Once the new image is saved, the old one is removed. The response has no data; read the company details for `customer_portal_bg`.

## Permission

Needs the Manage Settings permission. The team owner always has it.

## Side effects

- Customers see the new background the next time they open the portal.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `multipart/form-data`, required.

Fields:

- `media` (string (binary), required): A JPEG or PNG image, at most 4096 KiB (4 MB). YoPrint reads the type from the file's content, not its name.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/customer_portal_bg' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "media": "string"
  }'
```

This example is built from the field types: replace each value with a real one.

## Response

`200` Successful response.

Fields:

- `data` (null, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": null,
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your role lacks Manage Settings. The body is `{"message": "Insufficient Permission"}`, without the error envelope. Fix: Use the key of a member whose role has Manage Settings, or the owner's.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: `media` is missing, is not a JPEG or PNG image, or is larger than 4096 KiB (`validation_failed`; `error.fields.media` says which). The current background stays. Fix: Upload one JPEG or PNG file.

## Related

- [Remove the customer portal background](https://developer.yoprint.com/reference/company-settings/v1-setting-customer-portal-bg-delete.md): `DELETE /v1/api/store/{team_slug}/setting/customer_portal_bg`
- [Get your company details](https://developer.yoprint.com/reference/company-settings/v1-setting-detail-show.md): `GET /v1/api/store/{team_slug}/setting/detail`