> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Business

> Update an existing Business record.

Updates an existing Business record. You must include the `Id` of the record to update along with all required fields.

## Authentication

<Note>
  This endpoint requires OAuth2 authentication. Include a valid bearer token in the `Authorization` header.
  The authenticated user must be a full unrestricted administrator or have the **`Business-Edit`** role.
</Note>

## Enums

<Accordion title="eHelpItemFlag — VisitedHelpItems values">
  | Value | Name         |
  | ----- | ------------ |
  | 0     | None         |
  | 1     | WelcomePage  |
  | 2     | GridPage     |
  | 4     | EditPage     |
  | 8     | SettingsPage |
  | 16    | HelpPage     |
</Accordion>

<Accordion title="eLanguage — DefaultLanguage values">
  | Value | Name      |
  | ----- | --------- |
  | 3     | EnglishUK |
  | 1     | EnglishUS |
  | 2     | Spanish   |
</Accordion>

<Accordion title="eVenueType — VenueType values">
  | Value | Name            |
  | ----- | --------------- |
  | 1     | BusinessCenter  |
  | 2     | CorporateOffice |
  | 3     | CoworkingSpace  |
  | 4     | Hotel           |
  | 5     | InformalOffice  |
  | 6     | Studio          |
  | 7     | Other           |
</Accordion>

<Accordion title="eFloorUnit — FloorSpaceUnit values">
  | Value | Name |
  | ----- | ---- |
  | 1     | SqFt |
  | 2     | SqMt |
</Accordion>

<Accordion title="ePassportAccess — PassportMembersAccess values">
  | Value | Name                       |
  | ----- | -------------------------- |
  | 1     | Everyone                   |
  | 2     | RegisteredUsers            |
  | 3     | RegisteredWithMySpaceUsers |
  | 4     | NoOne                      |
</Accordion>

## Request Body

### Required Fields

<ParamField body="Id" type="integer" required>
  The Id of the Business record to update.
</ParamField>

<ParamField body="VisitedHelpItems" type="integer" required>
  The visited help items value for this business.
</ParamField>

<ParamField body="Name" type="string" required>
  Display name of the business location.
</ParamField>

<ParamField body="DefaultLanguage" type="integer" required>
  Default language identifier for communications and UI.
</ParamField>

<ParamField body="WebAddress" type="string" required>
  URL slug used for the business's public web address.
</ParamField>

<ParamField body="CountryId" type="integer" required>
  ID of the country linked to this record.
</ParamField>

<ParamField body="CurrencyId" type="integer" required>
  ID of the currency linked to this record.
</ParamField>

<ParamField body="SimpleTimeZoneId" type="integer" required>
  ID of the simple time zone linked to this record.
</ParamField>

<ParamField body="DiscountPercentage" type="number" required>
  The discount percentage value for this business.
</ParamField>

<ParamField body="DiscountAmount" type="number" required>
  The discount amount value for this business.
</ParamField>

<ParamField body="InvoicingPeriod" type="integer" required>
  The invoicing period value for this business.
</ParamField>

<ParamField body="LastChargedInvoice" type="integer" required>
  The last charged invoice value for this business.
</ParamField>

<ParamField body="LastChargedTransaction" type="integer" required>
  The last charged transaction value for this business.
</ParamField>

<ParamField body="LastChargedAttendee" type="integer" required>
  The last charged attendee value for this business.
</ParamField>

<ParamField body="VenueType" type="integer" required>
  Type of venue (0 = default).
</ParamField>

<ParamField body="FloorSpaceUnit" type="integer" required>
  Unit for FloorSpace (0 = default).
</ParamField>

<ParamField body="PassportMembersAccess" type="integer" required>
  Passport members directory access level.
</ParamField>

<ParamField body="PassportEventsAccess" type="integer" required>
  Passport events listing access level.
</ParamField>

<ParamField body="PassportCommunityAccess" type="integer" required>
  Passport community board access level.
</ParamField>

<ParamField body="PassportBlogPostsAccess" type="integer" required>
  Passport blog posts access level.
</ParamField>

### Optional Fields

<ParamField body="SpaceWebsiteLanguageId" type="integer">
  ID of the space website language linked to this record.
</ParamField>

<ParamField body="DefaultPaymentGatewayId" type="integer">
  ID of the default payment gateway linked to this record.
</ParamField>

<ParamField body="TermsAndConditions" type="string">
  Terms and conditions text for this business.
</ParamField>

<ParamField body="ShortIntroduction" type="string">
  Brief introduction shown on the business profile.
</ParamField>

<ParamField body="AboutUs" type="string">
  Extended 'About Us' text for the business profile.
</ParamField>

<ParamField body="Quote" type="string">
  Highlight quote displayed on the business profile.
</ParamField>

<ParamField body="PrivacyPolicyUrl" type="string">
  URL to the business's privacy policy.
</ParamField>

<ParamField body="CookiePolicyUrl" type="string">
  URL to the business's cookie policy.
</ParamField>

<ParamField body="WebContact" type="string">
  Public-facing web contact URL.
</ParamField>

<ParamField body="WelcomeEmail" type="string">
  The welcome email value for this business.
</ParamField>

<ParamField body="Address" type="string">
  Street address of the business.
</ParamField>

<ParamField body="Phone" type="string">
  Primary phone number displayed on the business profile.
</ParamField>

<ParamField body="Fax" type="string">
  Fax number.
</ParamField>

<ParamField body="EmailContact" type="string">
  Primary email address displayed on the business profile.
</ParamField>

<ParamField body="TrialExpireDate" type="string">
  Date/time value for trial expire date.
</ParamField>

<ParamField body="LastOverDueInvoiceReminder" type="string">
  Date/time value for last over due invoice reminder.
</ParamField>

<ParamField body="LastWelcomeEmail" type="string">
  Date/time value for last welcome email.
</ParamField>

<ParamField body="NewLogoUrl" type="string">
  URL of a new file to upload as the logo.
</ParamField>

<ParamField body="ClearLogoFile" type="boolean">
  Set to true to remove the current logo file.
</ParamField>

<ParamField body="NewBannerImageUrl" type="string">
  URL of a new file to upload as the banner image.
</ParamField>

<ParamField body="ClearBannerImageFile" type="boolean">
  Set to true to remove the current banner image file.
</ParamField>

<ParamField body="NewNexIoBannerImageUrl" type="string">
  URL of a new file to upload as the nex io banner image.
</ParamField>

<ParamField body="ClearNexIoBannerImageFile" type="boolean">
  Set to true to remove the current nex io banner image file.
</ParamField>

<ParamField body="LastLanguageTokenUpdate" type="string">
  Date/time value for last language token update.
</ParamField>

<ParamField body="HasCreatedDefaultFileTemplates" type="boolean">
  Whether has created default file templates is enabled.
</ParamField>

<ParamField body="Suspended" type="boolean">
  Whether suspended is enabled.
</ParamField>

<ParamField body="CustomPassportApp" type="boolean">
  Whether custom passport app is enabled.
</ParamField>

<ParamField body="RemindersProcessedOn" type="string">
  Date/time value for reminders processed on.
</ParamField>

<ParamField body="PreAuthId" type="string">
  ID of the pre auth associated with this record.
</ParamField>

<ParamField body="Last4Digits" type="string">
  Last 4 digits of the payment card on file.
</ParamField>

<ParamField body="PreAuthLastError" type="string">
  Most recent pre-authorisation error message.
</ParamField>

<ParamField body="PreAuthProcessedOn" type="string">
  Date/time value for pre auth processed on.
</ParamField>

<ParamField body="PassportChannels" type="string">
  Passport channels this business is listed under.
</ParamField>

<ParamField body="PassportOnly" type="boolean">
  Whether passport only is enabled.
</ParamField>

<ParamField body="PassportPublished" type="boolean">
  Whether this business is published and visible on Nexudus Passport.
</ParamField>

<ParamField body="NewPassportBannerUrl" type="string">
  URL of a new file to upload as the passport banner.
</ParamField>

<ParamField body="ClearPassportBannerFile" type="boolean">
  Set to true to remove the current passport banner file.
</ParamField>

<ParamField body="PassportSpaceName" type="string">
  Display name shown on the Nexudus Passport listing.
</ParamField>

<ParamField body="PassportTagLine" type="string">
  Tagline shown on the Nexudus Passport listing.
</ParamField>

<ParamField body="Tags" type="string">
  Comma-separated tags for categorising the business.
</ParamField>

<ParamField body="NumberOfFloors" type="integer">
  Number of floors in the business premises.
</ParamField>

<ParamField body="FloorSpace" type="integer">
  Total floor space of the business premises.
</ParamField>

<ParamField body="Longitude" type="number">
  Longitude coordinate for map positioning.
</ParamField>

<ParamField body="Latitude" type="number">
  Latitude coordinate for map positioning.
</ParamField>

<ParamField body="PassportDescription" type="string">
  Full description shown on the Nexudus Passport listing.
</ParamField>

<ParamField body="TownCity" type="string">
  Town or city where the business is located.
</ParamField>

<ParamField body="State" type="string">
  State or province where the business is located.
</ParamField>

<ParamField body="PostalCode" type="string">
  Postal or ZIP code.
</ParamField>

<ParamField body="StreetName" type="string">
  Street name component of the address.
</ParamField>

<ParamField body="StreetNumber" type="string">
  Street number component of the address.
</ParamField>

<ParamField body="Neighborhood" type="string">
  Neighborhood or district name.
</ParamField>

<ParamField body="ContactPhoneNumber" type="string">
  Secondary contact phone number.
</ParamField>

<ParamField body="ContactEmail" type="string">
  Secondary contact email address.
</ParamField>

<ParamField body="MondayOpenTime" type="integer">
  Monday opening time (minutes from midnight).
</ParamField>

<ParamField body="MondayCloseTime" type="integer">
  Monday closing time (minutes from midnight).
</ParamField>

<ParamField body="TuesdayOpenTime" type="integer">
  Tuesday opening time (minutes from midnight).
</ParamField>

<ParamField body="TuesdayCloseTime" type="integer">
  Tuesday closing time (minutes from midnight).
</ParamField>

<ParamField body="WednesdayOpenTime" type="integer">
  Wednesday opening time (minutes from midnight).
</ParamField>

<ParamField body="WednesdayCloseTime" type="integer">
  Wednesday closing time (minutes from midnight).
</ParamField>

<ParamField body="ThursdayOpenTime" type="integer">
  Thursday opening time (minutes from midnight).
</ParamField>

<ParamField body="ThursdayCloseTime" type="integer">
  Thursday closing time (minutes from midnight).
</ParamField>

<ParamField body="FridayOpenTime" type="integer">
  Friday opening time (minutes from midnight).
</ParamField>

<ParamField body="FridayCloseTime" type="integer">
  Friday closing time (minutes from midnight).
</ParamField>

<ParamField body="SaturdayOpenTime" type="integer">
  Saturday opening time (minutes from midnight).
</ParamField>

<ParamField body="SaturdayCloseTime" type="integer">
  Saturday closing time (minutes from midnight).
</ParamField>

<ParamField body="SundayOpenTime" type="integer">
  Sunday opening time (minutes from midnight).
</ParamField>

<ParamField body="SundayCloseTime" type="integer">
  Sunday closing time (minutes from midnight).
</ParamField>

<ParamField body="MondayClosed" type="boolean">
  Whether the business is closed on Mondays.
</ParamField>

<ParamField body="TuesdayClosed" type="boolean">
  Whether the business is closed on Tuesdays.
</ParamField>

<ParamField body="WednesdayClosed" type="boolean">
  Whether the business is closed on Wednesdays.
</ParamField>

<ParamField body="ThursdayClosed" type="boolean">
  Whether the business is closed on Thursdays.
</ParamField>

<ParamField body="FridayClosed" type="boolean">
  Whether the business is closed on Fridays.
</ParamField>

<ParamField body="SaturdayClosed" type="boolean">
  Whether the business is closed on Saturdays.
</ParamField>

<ParamField body="SundayClosed" type="boolean">
  Whether the business is closed on Sundays.
</ParamField>

<ParamField body="SameOpeningTimes" type="boolean">
  Whether all days share the same opening and closing times.
</ParamField>

<ParamField body="CurrentBackEndVersion" type="integer">
  The current back end version value for this business.
</ParamField>

<ParamField body="AuthenticationProvider" type="string">
  The authentication provider value for this business.
</ParamField>

<ParamField body="CreatedBy" type="string">
  The created by value for this business.
</ParamField>

<ParamField body="DefaultPaymentTerm" type="integer">
  The default payment term value for this business.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PUT \
    "https://spaces.nexudus.com/api/sys/businesses" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "VisitedHelpItems": 0,
      "Name": "",
      "DefaultLanguage": 0,
      "WebAddress": "",
      "CountryId": 0,
      "CurrencyId": 0,
      "SimpleTimeZoneId": 0,
      "DiscountPercentage": 0,
      "DiscountAmount": 0,
      "InvoicingPeriod": 0,
      "LastChargedInvoice": 0,
      "LastChargedTransaction": 0,
      "LastChargedAttendee": 0,
      "VenueType": 0,
      "FloorSpaceUnit": 0,
      "PassportMembersAccess": 0,
      "PassportEventsAccess": 0,
      "PassportCommunityAccess": 0,
      "PassportBlogPostsAccess": 0,
      "Id": 87654321
  }'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/businesses',
    {
      method: 'PUT',
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        VisitedHelpItems: 0,
        Name: '',
        DefaultLanguage: 0,
        WebAddress: '',
        CountryId: 0,
        CurrencyId: 0,
        SimpleTimeZoneId: 0,
        DiscountPercentage: 0,
        DiscountAmount: 0,
        InvoicingPeriod: 0,
        LastChargedInvoice: 0,
        LastChargedTransaction: 0,
        LastChargedAttendee: 0,
        VenueType: 0,
        FloorSpaceUnit: 0,
        PassportMembersAccess: 0,
        PassportEventsAccess: 0,
        PassportCommunityAccess: 0,
        PassportBlogPostsAccess: 0,
        Id: 87654321
      })
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
      'https://spaces.nexudus.com/api/sys/businesses',
      headers={
          'Authorization': 'Bearer YOUR_TOKEN',
          'Content-Type': 'application/json'
      },
      json={
          'VisitedHelpItems': 0,
          'Name': '',
          'DefaultLanguage': 0,
          'WebAddress': '',
          'CountryId': 0,
          'CurrencyId': 0,
          'SimpleTimeZoneId': 0,
          'DiscountPercentage': 0,
          'DiscountAmount': 0,
          'InvoicingPeriod': 0,
          'LastChargedInvoice': 0,
          'LastChargedTransaction': 0,
          'LastChargedAttendee': 0,
          'VenueType': 0,
          'FloorSpaceUnit': 0,
          'PassportMembersAccess': 0,
          'PassportEventsAccess': 0,
          'PassportCommunityAccess': 0,
          'PassportBlogPostsAccess': 0,
          'Id': 87654321
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Status" type="integer">
  HTTP status code. `200` on success.
</ResponseField>

<ResponseField name="Message" type="string">
  A human-readable message confirming the update.
</ResponseField>

<ResponseField name="Value" type="object">
  Contains the `Id` of the updated record.
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `true` if the business was updated successfully.
</ResponseField>

<ResponseField name="Errors" type="array">
  `null` on success.
</ResponseField>

```json Example Response theme={null}
{
  "Status": 200,
  "Message": "Business was successfully updated.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}
```

### 400

<ResponseField name="Message" type="string">
  A summary of the validation error(s), in the format `PropertyName: error message`.
</ResponseField>

<ResponseField name="Value" type="any">
  `null` on validation failure.
</ResponseField>

<ResponseField name="Errors" type="object[]">
  Array of validation errors.

  <Expandable>
    <ResponseField name="AttemptedValue" type="any">
      The value that was submitted for the field, or `null` if missing.
    </ResponseField>

    <ResponseField name="Message" type="string">
      The validation error message.
    </ResponseField>

    <ResponseField name="PropertyName" type="string">
      The name of the property that failed validation.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="WasSuccessful" type="boolean">
  `false` when the request fails validation.
</ResponseField>

```json Example Response theme={null}
{
  "Message": "VisitedHelpItems: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "VisitedHelpItems"
    }
  ],
  "WasSuccessful": false
}
```
