businesses

Edit Business

Use to update a business' data.

patch/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

Path parameters

slugstring required

Headers

x-api-keystring required

The application secret provided to the client.

Request body

titlestring

business entity's title.

descriptionstring nullable

any description on the business.

extra_dataunknown
logostring binary nullable

a logo for the business

forms_subdomainstring nullable

a subdomain to for showing the business' forms.

forms_custom_domainstring 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_domainstring 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_domainstring 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

planstring
titlestring required

business entity's title.

descriptionstring nullable

any description on the business.

slugstring nullable
last_updatestring date-time nullable

shows when was the user base data updated last time.

business_identifierstring nullable
extra_dataunknown
access_levelstring
logostring uri nullable

a logo for the business

iconstring uri
fav_iconstring uri
forms_subdomainstring nullable

a subdomain to for showing the business' forms.

forms_custom_domainstring 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_domainstring 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_domainstring 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_addressstring
total_available_seatsinteger
used_seatsinteger
white_labelboolean
available_featuresstring

List of available features for this business.

features_visibilityunknown
used_trialboolean

has the business used a trial before?

Changes

No recorded changes to this operation across all 1 revision of this API.