---
title: "Edit Business"
method: PUT
path: "/v3.0/businesses/{slug}/"
tags: ["businesses"]
---

# Edit Business

`PUT /v3.0/businesses/{slug}/`

## Request

- Base URL: `https://api.formaloo.me`
- URL: `https://api.formaloo.me/v3.0/businesses/{slug}/`
- Auth: none declared. Required headers: `x-api-key`

Use to update a business' data.

## Path parameters

- `slug` string, required

## Headers

- `x-api-key` string, required

## Request body

- BusinessRequest
  - `title` string, required: business entity's title.
  - `description` string, nullable: any description on the business.
  - `extra_data` unknown
  - `logo` string, binary, nullable: a logo for the business
  - `forms_subdomain` string, nullable: a subdomain to for showing the business' forms.
  - `forms_custom_domain` string, nullable: user can set this on their business, if they want to show their forms on a custom domain (e.g. https://example.co/form_address/).
  - `boards_custom_domain` string, nullable: user can set this on their business, if they want to show their boards on a custom domain (e.g. https://example.co/app_address/).
  - `dashboard_custom_domain` string, nullable: user can set this on their business, if they want to show their dashboard on a custom domain (e.g. https://dash.example.co/).

## Response `200`

- Business
  - `plan` string
  - `title` string, required: business entity's title.
  - `description` string, nullable: any description on the business.
  - `slug` string, nullable
  - `last_update` string, date-time, nullable: shows when was the user base data updated last time.
  - `business_identifier` string, nullable
  - `extra_data` unknown
  - `access_level` string
  - `logo` string, uri, nullable: a logo for the business
  - `icon` string, uri
  - `fav_icon` string, uri
  - `forms_subdomain` string, nullable: a subdomain to for showing the business' forms.
  - `forms_custom_domain` string, nullable: user can set this on their business, if they want to show their forms on a custom domain (e.g. https://example.co/form_address/).
  - `boards_custom_domain` string, nullable: user can set this on their business, if they want to show their boards on a custom domain (e.g. https://example.co/app_address/).
  - `dashboard_custom_domain` string, nullable: user can set this on their business, if they want to show their dashboard on a custom domain (e.g. https://dash.example.co/).
  - `dashboard_address` string
  - `total_available_seats` integer
  - `used_seats` integer
  - `white_label` boolean
  - `available_features` string: List of available features for this business.
  - `features_visibility` unknown
  - `used_trial` boolean: has the business used a trial before?

---

[API](https://skmtc.dev/formaloo/apis/formaloo-api-documentation.md) · [All operations](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/llms.txt) · [OpenAPI document](https://skmtc.dev/formaloo/apis/formaloo-api-documentation/revisions/47b268aeb656?raw)