Skip to content
Bottle

Update the business profile

PATCH
/business
curl --request PATCH \
  --url https://example.com/business \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "companyNumber": "example", "registeredAddress": { "line1": "example", "city": "example", "postcode": "example" } }'

Renames the business or sets its company particulars. A company number is eight digits, or two letters and six; send null for none.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 2 characters <= 120 characters
companyNumber
string | null
registeredAddress
object
line1
required
string
>= 1 characters <= 200 characters
city
string | null
<= 120 characters
postcode
required
string
>= 5 characters <= 8 characters
Examplegenerated
{
  "name": "example",
  "companyNumber": "example",
  "registeredAddress": {
    "line1": "example",
    "city": "example",
    "postcode": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

The profile as it now stands

Media typeapplication/json
object
name
required
string
companyNumber
required
string | null
registeredAddress
required
object
line1
required
string
city
required
string | null
postcode
required
string
Example
{
  "name": "Acme Gas",
  "companyNumber": "01234567",
  "registeredAddress": {
    "line1": "1 Yard Lane",
    "city": "Kingston upon Thames",
    "postcode": "KT1 1EU"
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}