Update Business

PUT

api

sys

businesses

Update Business

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/businesses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "VisitedHelpItems": 123,
  "Name": "<string>",
  "DefaultLanguage": 123,
  "WebAddress": "<string>",
  "CountryId": 123,
  "CurrencyId": 123,
  "SimpleTimeZoneId": 123,
  "DiscountPercentage": 123,
  "DiscountAmount": 123,
  "InvoicingPeriod": 123,
  "LastChargedInvoice": 123,
  "LastChargedTransaction": 123,
  "LastChargedAttendee": 123,
  "VenueType": 123,
  "FloorSpaceUnit": 123,
  "PassportMembersAccess": 123,
  "PassportEventsAccess": 123,
  "PassportCommunityAccess": 123,
  "PassportBlogPostsAccess": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/businesses"

payload = {
    "Id": 123,
    "VisitedHelpItems": 123,
    "Name": "<string>",
    "DefaultLanguage": 123,
    "WebAddress": "<string>",
    "CountryId": 123,
    "CurrencyId": 123,
    "SimpleTimeZoneId": 123,
    "DiscountPercentage": 123,
    "DiscountAmount": 123,
    "InvoicingPeriod": 123,
    "LastChargedInvoice": 123,
    "LastChargedTransaction": 123,
    "LastChargedAttendee": 123,
    "VenueType": 123,
    "FloorSpaceUnit": 123,
    "PassportMembersAccess": 123,
    "PassportEventsAccess": 123,
    "PassportCommunityAccess": 123,
    "PassportBlogPostsAccess": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    VisitedHelpItems: 123,
    Name: '<string>',
    DefaultLanguage: 123,
    WebAddress: '<string>',
    CountryId: 123,
    CurrencyId: 123,
    SimpleTimeZoneId: 123,
    DiscountPercentage: 123,
    DiscountAmount: 123,
    InvoicingPeriod: 123,
    LastChargedInvoice: 123,
    LastChargedTransaction: 123,
    LastChargedAttendee: 123,
    VenueType: 123,
    FloorSpaceUnit: 123,
    PassportMembersAccess: 123,
    PassportEventsAccess: 123,
    PassportCommunityAccess: 123,
    PassportBlogPostsAccess: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/businesses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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

Authentication

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.

Enums

eHelpItemFlag — VisitedHelpItems values

Value	Name
0	None
1	WelcomePage
2	GridPage
4	EditPage
8	SettingsPage
16	HelpPage

eLanguage — DefaultLanguage values

Value	Name
3	EnglishUK
1	EnglishUS
2	Spanish

eVenueType — VenueType values

Value	Name
1	BusinessCenter
2	CorporateOffice
3	CoworkingSpace
4	Hotel
5	InformalOffice
6	Studio
7	Other

eFloorUnit — FloorSpaceUnit values

Value	Name
1	SqFt
2	SqMt

ePassportAccess — PassportMembersAccess values

Value	Name
1	Everyone
2	RegisteredUsers
3	RegisteredWithMySpaceUsers
4	NoOne

Request Body

Required Fields

integer

required

The Id of the Business record to update.

integer

required

The visited help items value for this business.

string

required

Display name of the business location.

integer

required

Default language identifier for communications and UI.

string

required

URL slug used for the business’s public web address.

integer

required

ID of the country linked to this record.

integer

required

ID of the currency linked to this record.

integer

required

ID of the simple time zone linked to this record.

number

required

The discount percentage value for this business.

number

required

The discount amount value for this business.

integer

required

The invoicing period value for this business.

integer

required

The last charged invoice value for this business.

integer

required

The last charged transaction value for this business.

integer

required

The last charged attendee value for this business.

integer

required

Type of venue (0 = default).

integer

required

Unit for FloorSpace (0 = default).

integer

required

Passport members directory access level.

integer

required

Passport events listing access level.

integer

required

Passport community board access level.

integer

required

Passport blog posts access level.

Optional Fields

integer

ID of the space website language linked to this record.

integer

ID of the default payment gateway linked to this record.

string

Terms and conditions text for this business.

string

Brief introduction shown on the business profile.

string

Extended ‘About Us’ text for the business profile.

string

Highlight quote displayed on the business profile.

string

URL to the business’s privacy policy.

URL to the business’s cookie policy.

string

Public-facing web contact URL.

string

The welcome email value for this business.

string

Street address of the business.

string

Primary phone number displayed on the business profile.

string

Fax number.

string

Primary email address displayed on the business profile.

string

Date/time value for trial expire date.

string

Date/time value for last over due invoice reminder.

string

Date/time value for last welcome email.

string

URL of a new file to upload as the logo.

boolean

Set to true to remove the current logo file.

string

URL of a new file to upload as the banner image.

boolean

Set to true to remove the current banner image file.

string

URL of a new file to upload as the nex io banner image.

boolean

Set to true to remove the current nex io banner image file.

string

Date/time value for last language token update.

boolean

Whether has created default file templates is enabled.

boolean

Whether suspended is enabled.

boolean

Whether custom passport app is enabled.

string

Date/time value for reminders processed on.

string

ID of the pre auth associated with this record.

string

Last 4 digits of the payment card on file.

string

Most recent pre-authorisation error message.

string

Date/time value for pre auth processed on.

string

Passport channels this business is listed under.

boolean

Whether passport only is enabled.

boolean

Whether this business is published and visible on Nexudus Passport.

string

URL of a new file to upload as the passport banner.

boolean

Set to true to remove the current passport banner file.

string

Display name shown on the Nexudus Passport listing.

string

Tagline shown on the Nexudus Passport listing.

string

Comma-separated tags for categorising the business.

integer

Number of floors in the business premises.

integer

Total floor space of the business premises.

number

Longitude coordinate for map positioning.

number

Latitude coordinate for map positioning.

string

Full description shown on the Nexudus Passport listing.

string

Town or city where the business is located.

string

State or province where the business is located.

string

Postal or ZIP code.

string

Street name component of the address.

string

Street number component of the address.

string

Neighborhood or district name.

string

Secondary contact phone number.

string

Secondary contact email address.

integer

Monday opening time (minutes from midnight).

integer

Monday closing time (minutes from midnight).

integer

Tuesday opening time (minutes from midnight).

integer

Tuesday closing time (minutes from midnight).

integer

Wednesday opening time (minutes from midnight).

integer

Wednesday closing time (minutes from midnight).

integer

Thursday opening time (minutes from midnight).

integer

Thursday closing time (minutes from midnight).

integer

Friday opening time (minutes from midnight).

integer

Friday closing time (minutes from midnight).

integer

Saturday opening time (minutes from midnight).

integer

Saturday closing time (minutes from midnight).

integer

Sunday opening time (minutes from midnight).

integer

Sunday closing time (minutes from midnight).

boolean

Whether the business is closed on Mondays.

boolean

Whether the business is closed on Tuesdays.

boolean

Whether the business is closed on Wednesdays.

boolean

Whether the business is closed on Thursdays.

boolean

Whether the business is closed on Fridays.

boolean

Whether the business is closed on Saturdays.

boolean

Whether the business is closed on Sundays.

boolean

Whether all days share the same opening and closing times.

integer

The current back end version value for this business.

string

The authentication provider value for this business.

string

The created by value for this business.

integer

The default payment term value for this business.

Code Examples

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
}'

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();

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()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the business was updated successfully.

array

null on success.

Example Response

{
  "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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "VisitedHelpItems: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "VisitedHelpItems"
    }
  ],
  "WasSuccessful": false
}

Search BusinessRedirectionsSearch and list BusinessRedirection records with filtering, sorting, and pagination.

Update Business

curl --request PUT \
  --url https://spaces.nexudus.com/api/sys/businesses \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Id": 123,
  "VisitedHelpItems": 123,
  "Name": "<string>",
  "DefaultLanguage": 123,
  "WebAddress": "<string>",
  "CountryId": 123,
  "CurrencyId": 123,
  "SimpleTimeZoneId": 123,
  "DiscountPercentage": 123,
  "DiscountAmount": 123,
  "InvoicingPeriod": 123,
  "LastChargedInvoice": 123,
  "LastChargedTransaction": 123,
  "LastChargedAttendee": 123,
  "VenueType": 123,
  "FloorSpaceUnit": 123,
  "PassportMembersAccess": 123,
  "PassportEventsAccess": 123,
  "PassportCommunityAccess": 123,
  "PassportBlogPostsAccess": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/businesses"

payload = {
    "Id": 123,
    "VisitedHelpItems": 123,
    "Name": "<string>",
    "DefaultLanguage": 123,
    "WebAddress": "<string>",
    "CountryId": 123,
    "CurrencyId": 123,
    "SimpleTimeZoneId": 123,
    "DiscountPercentage": 123,
    "DiscountAmount": 123,
    "InvoicingPeriod": 123,
    "LastChargedInvoice": 123,
    "LastChargedTransaction": 123,
    "LastChargedAttendee": 123,
    "VenueType": 123,
    "FloorSpaceUnit": 123,
    "PassportMembersAccess": 123,
    "PassportEventsAccess": 123,
    "PassportCommunityAccess": 123,
    "PassportBlogPostsAccess": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Id: 123,
    VisitedHelpItems: 123,
    Name: '<string>',
    DefaultLanguage: 123,
    WebAddress: '<string>',
    CountryId: 123,
    CurrencyId: 123,
    SimpleTimeZoneId: 123,
    DiscountPercentage: 123,
    DiscountAmount: 123,
    InvoicingPeriod: 123,
    LastChargedInvoice: 123,
    LastChargedTransaction: 123,
    LastChargedAttendee: 123,
    VenueType: 123,
    FloorSpaceUnit: 123,
    PassportMembersAccess: 123,
    PassportEventsAccess: 123,
    PassportCommunityAccess: 123,
    PassportBlogPostsAccess: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/businesses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400