Sign in
Businesses

Update a business

post/businesses/{id}

Path parameters

idstring required

The ID of the business

Request body

namestring

The updated name of the business. Can be omitted

metadataobject nullable

Arbitrary metadata to associate with the business

external_idstring nullable

An external identifier for the business. Must be unique within the project

websitestring nullable

The website URL for the business

disabled_stepsstring[] nullable

Steps to disable for this business. Pass null to inherit the project's disabled_steps. Pass an array (including []) to override the project's setting.

Response

The updated Business object

idstring required

The ID of the business

external_idstring nullable required

The external ID of the business

namestring required

The name of the business

metadataobject required

Arbitrary metadata associated with this business

created_atstring required

The date and time the business was created

websitestring nullable required

The website URL of the business

disabled_stepsstring[] nullable required

Steps disabled for this business. If null, the business inherits the project's disabled_steps. If set (including []), this list fully overrides the project's setting.

Changes

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