PUT /businesses

Updates the business data for the business of the user making the request.

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True BusinessAdministrator

Request Information

Parameters

Name Source Description
business Part of the request HTTP body The business.

Parameter Properties

  • business
    • CompaniesHouseRegistrationNumber
      Companies House registration number for the business.
    • Id
      edoc generated unique identifier for the business.
      Remarks: Mandatory.
    • IsBroker
      Indicates whether the business is a waste broker or not.
    • IsCarrier
      Indicates whether the business is a waste carrier or not.
    • IsDealer
      Indicates whether the business is a waste dealer or not.
    • IsImporter
      Indicates whether the business is a waste importer or not.
    • IsLocalAuthority
      Indicates whether the business is a local authority or not.
    • IsProducer
      Indicates whether the business is a producer of waste or not.
    • Name
      The name of the business.
      Remarks: Mandatory.
    • PreferredEmailLanguage
      The preferred language for emails sent from the system to this business.
    • RegistrationNumbers
      A list of the waste broker, dealer and/or carrier registration numbers for the business.
    • UseReportingWhitelist
      Indicates whether the business should use its reporting whitelist for controlling reporting visibility for involved parties to waste transfer notes it has created.
    • UseVisibilityWhitelist
      Indicates whether the business should use its visibility whitelist for controlling visibility for involved parties to waste transfer notes it has created.

Request body formats

Sample:
{
  "CompaniesHouseRegistrationNumber": "54326622",
  "Id": "93a376d4-7762-4418-98b3-2764cb6a3bc7",
  "IsBroker": true,
  "IsCarrier": true,
  "IsDealer": true,
  "IsImporter": true,
  "IsLocalAuthority": true,
  "IsProducer": true,
  "Name": "Bob's Skips Ltd",
  "PreferredEmailLanguage": "English",
  "RegistrationNumbers": [
    "54321/43/D",
    "432/323-F4"
  ],
  "UseReportingWhitelist": true,
  "UseVisibilityWhitelist": true
}
Sample:
<Business xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <CompaniesHouseRegistrationNumber>54326622</CompaniesHouseRegistrationNumber>
  <Id>93a376d4-7762-4418-98b3-2764cb6a3bc7</Id>
  <IsBroker>true</IsBroker>
  <IsCarrier>true</IsCarrier>
  <IsDealer>true</IsDealer>
  <IsImporter>true</IsImporter>
  <IsLocalAuthority>true</IsLocalAuthority>
  <IsProducer>true</IsProducer>
  <Name>Bob's Skips Ltd</Name>
  <PreferredEmailLanguage>English</PreferredEmailLanguage>
  <RegistrationNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>54321/43/D</d2p1:string>
    <d2p1:string>432/323-F4</d2p1:string>
  </RegistrationNumbers>
  <UseReportingWhitelist>true</UseReportingWhitelist>
  <UseVisibilityWhitelist>true</UseVisibilityWhitelist>
</Business>