Update Business - Nexudus Platform

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

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

VisitedHelpItems

integer

required

The visited help items value for this business.

Name

string

required

Display name of the business location.

DefaultLanguage

integer

required

Default language identifier for communications and UI.

WebAddress

string

required

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

CountryId

integer

required

ID of the country linked to this record.

CurrencyId

integer

required

ID of the currency linked to this record.

SimpleTimeZoneId

integer

required

ID of the simple time zone linked to this record.

DiscountPercentage

number

required

The discount percentage value for this business.

DiscountAmount

number

required

The discount amount value for this business.

InvoicingPeriod

integer

required

The invoicing period value for this business.

LastChargedInvoice

integer

required

The last charged invoice value for this business.

LastChargedTransaction

integer

required

The last charged transaction value for this business.

LastChargedAttendee

integer

required

The last charged attendee value for this business.

VenueType

integer

required

Type of venue (0 = default).

FloorSpaceUnit

integer

required

Unit for FloorSpace (0 = default).

PassportMembersAccess

integer

required

Passport members directory access level.

PassportEventsAccess

integer

required

Passport events listing access level.

PassportCommunityAccess

integer

required

Passport community board access level.

PassportBlogPostsAccess

integer

required

Passport blog posts access level.

Optional Fields

SpaceWebsiteLanguageId

integer

ID of the space website language linked to this record.

DefaultPaymentGatewayId

integer

ID of the default payment gateway linked to this record.

TermsAndConditions

string

Terms and conditions text for this business.

ShortIntroduction

string

Brief introduction shown on the business profile.

AboutUs

string

Extended ‘About Us’ text for the business profile.

Quote

string

Highlight quote displayed on the business profile.

PrivacyPolicyUrl

string

URL to the business’s privacy policy.

URL to the business’s cookie policy.

WebContact

string

Public-facing web contact URL.

WelcomeEmail

string

The welcome email value for this business.

Address

string

Street address of the business.

Phone

string

Primary phone number displayed on the business profile.

Fax

string

Fax number.

EmailContact

string

Primary email address displayed on the business profile.

TrialExpireDate

string

Date/time value for trial expire date.

LastOverDueInvoiceReminder

string

Date/time value for last over due invoice reminder.

LastWelcomeEmail

string

Date/time value for last welcome email.

NewLogoUrl

string

URL of a new file to upload as the logo.

ClearLogoFile

boolean

Set to true to remove the current logo file.

NewBannerImageUrl

string

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

ClearBannerImageFile

boolean

Set to true to remove the current banner image file.

NewNexIoBannerImageUrl

string

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

ClearNexIoBannerImageFile

boolean

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

LastLanguageTokenUpdate

string

Date/time value for last language token update.

HasCreatedDefaultFileTemplates

boolean

Whether has created default file templates is enabled.

Suspended

boolean

Whether suspended is enabled.

CustomPassportApp

boolean

Whether custom passport app is enabled.

RemindersProcessedOn

string

Date/time value for reminders processed on.

PreAuthId

string

ID of the pre auth associated with this record.

Last4Digits

string

Last 4 digits of the payment card on file.

PreAuthLastError

string

Most recent pre-authorisation error message.

PreAuthProcessedOn

string

Date/time value for pre auth processed on.

PassportChannels

string

Passport channels this business is listed under.

PassportOnly

boolean

Whether passport only is enabled.

PassportPublished

boolean

Whether this business is published and visible on Nexudus Passport.

NewPassportBannerUrl

string

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

ClearPassportBannerFile

boolean

Set to true to remove the current passport banner file.

PassportSpaceName

string

Display name shown on the Nexudus Passport listing.

PassportTagLine

string

Tagline shown on the Nexudus Passport listing.

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

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the update.

Value

object

Contains the Id of the updated record.

WasSuccessful

boolean

true if the business was updated successfully.

Errors

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

Message

string

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

Value

any

null on validation failure.

Errors

object[]

Array of validation errors.

Show child attributes

AttemptedValue

any

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

Message

string

The validation error message.

PropertyName

string

The name of the property that failed validation.

WasSuccessful

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

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

​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