Skip to main content
POST
/
businesses
/
{id}
Update a business
curl --request POST \
  --url https://api.pocketflows.com/businesses/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "metadata": {},
  "external_id": "<string>",
  "website": "<string>",
  "disabled_steps": []
}
'
{
  "id": "<string>",
  "external_id": "<string>",
  "name": "<string>",
  "metadata": {},
  "created_at": "<string>",
  "website": "<string>",
  "disabled_steps": []
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the business

Body

application/json
​
name
string

The updated name of the business. Can be omitted

​
metadata
object

Arbitrary metadata to associate with the business

​
external_id
string | null

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

​
website
string | null

The website URL for the business

​
disabled_steps
enum<string>[] | null

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.

Available options:
email,
sms

Response

200 - application/json

The updated Business object

​
id
string
required

The ID of the business

​
external_id
string | null
required

The external ID of the business

​
name
string
required

The name of the business

​
metadata
object
required

Arbitrary metadata associated with this business

​
created_at
string
required

The date and time the business was created

​
website
string | null
required

The website URL of the business

​
disabled_steps
enum<string>[] | null
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.

Available options:
email,
sms