Skip to main content
PUT
/
api
/
sys
/
businesses
{
  "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.

Request Body

Required Fields

Id
integer
required
The Id of the Business record to update.
Name
string
required
Display name of the business location.
WebAddress
string
required
URL slug used for the business’s public web address.
CountryId
integer
required
Country Id.
CurrencyId
integer
required
Currency Id.
SimpleTimeZoneId
integer
required
Simple Time Zone Id.
DiscountPercentage
number
required
Discount Percentage.
DiscountAmount
number
required
Discount Amount.
InvoicingPeriod
integer
required
Invoicing Period.
LastChargedInvoice
integer
required
Last Charged Invoice.
LastChargedTransaction
integer
required
Last Charged Transaction.
LastChargedAttendee
integer
required
Last Charged Attendee.

Optional Fields

VisitedHelpItems
integer
Visited Help Items. See eHelpItemFlag enum above.
DefaultLanguage
integer
Default language identifier for communications and UI. See eLanguage enum above.
SpaceWebsiteLanguageId
integer
Space Website Language Id.
DefaultPaymentGatewayId
integer
Default Payment Gateway Id.
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
Welcome Email.
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
Trial Expire Date.
LastOverDueInvoiceReminder
string
Last Over Due Invoice Reminder.
LastWelcomeEmail
string
Last Welcome Email.
NewLogoUrl
string
New Logo Url.
ClearLogoFile
boolean
Clear Logo File.
NewBannerImageUrl
string
New Banner Image Url.
ClearBannerImageFile
boolean
Clear Banner Image File.
NewNexIoBannerImageUrl
string
New Nex Io Banner Image Url.
ClearNexIoBannerImageFile
boolean
Clear Nex Io Banner Image File.
LastLanguageTokenUpdate
string
Last Language Token Update.
HasCreatedDefaultFileTemplates
boolean
Has Created Default File Templates.
Suspended
boolean
Suspended.
CustomPassportApp
boolean
Custom Passport App.
RemindersProcessedOn
string
Reminders Processed On.
PreAuthId
string
Pre Auth Id.
Last4Digits
string
Last 4 digits of the payment card on file.
PreAuthLastError
string
Most recent pre-authorisation error message.
PreAuthProcessedOn
string
Pre Auth Processed On.
PassportChannels
string
Passport channels this business is listed under.
PassportOnly
boolean
Passport Only.
PassportPublished
boolean
Whether this business is published and visible on Nexudus Passport.
NewPassportBannerUrl
string
New Passport Banner Url.
ClearPassportBannerFile
boolean
Clear Passport Banner File.
PassportSpaceName
string
Display name shown on the Nexudus Passport listing.
PassportTagLine
string
Tagline shown on the Nexudus Passport listing.
VenueType
integer
Type of venue (0 = default). See eVenueType enum above.
Tags
string
Comma-separated tags for categorising the business.
NumberOfFloors
integer
Number of floors in the business premises.
FloorSpace
integer
Total floor space of the business premises.
FloorSpaceUnit
integer
Unit for FloorSpace (0 = default). See eFloorUnit enum above.
Longitude
number
Longitude coordinate for map positioning.
Latitude
number
Latitude coordinate for map positioning.
PassportDescription
string
Full description shown on the Nexudus Passport listing.
TownCity
string
Town or city where the business is located.
State
string
State or province where the business is located.
PostalCode
string
Postal or ZIP code.
StreetName
string
Street name component of the address.
StreetNumber
string
Street number component of the address.
Neighborhood
string
Neighborhood or district name.
ContactPhoneNumber
string
Secondary contact phone number.
ContactEmail
string
Secondary contact email address.
PassportMembersAccess
integer
Passport members directory access level. See ePassportAccess enum above.
PassportEventsAccess
integer
Passport events listing access level. See ePassportAccess enum above.
PassportCommunityAccess
integer
Passport community board access level. See ePassportAccess enum above.
PassportBlogPostsAccess
integer
Passport blog posts access level. See ePassportAccess enum above.
MondayOpenTime
integer
Monday opening time (minutes from midnight).
MondayCloseTime
integer
Monday closing time (minutes from midnight).
TuesdayOpenTime
integer
Tuesday opening time (minutes from midnight).
TuesdayCloseTime
integer
Tuesday closing time (minutes from midnight).
WednesdayOpenTime
integer
Wednesday opening time (minutes from midnight).
WednesdayCloseTime
integer
Wednesday closing time (minutes from midnight).
ThursdayOpenTime
integer
Thursday opening time (minutes from midnight).
ThursdayCloseTime
integer
Thursday closing time (minutes from midnight).
FridayOpenTime
integer
Friday opening time (minutes from midnight).
FridayCloseTime
integer
Friday closing time (minutes from midnight).
SaturdayOpenTime
integer
Saturday opening time (minutes from midnight).
SaturdayCloseTime
integer
Saturday closing time (minutes from midnight).
SundayOpenTime
integer
Sunday opening time (minutes from midnight).
SundayCloseTime
integer
Sunday closing time (minutes from midnight).
MondayClosed
boolean
Whether the business is closed on Mondays.
TuesdayClosed
boolean
Whether the business is closed on Tuesdays.
WednesdayClosed
boolean
Whether the business is closed on Wednesdays.
ThursdayClosed
boolean
Whether the business is closed on Thursdays.
FridayClosed
boolean
Whether the business is closed on Fridays.
SaturdayClosed
boolean
Whether the business is closed on Saturdays.
SundayClosed
boolean
Whether the business is closed on Sundays.
SameOpeningTimes
boolean
Whether all days share the same opening and closing times.
CurrentBackEndVersion
integer
Current Back End Version.
AuthenticationProvider
string
Authentication Provider.
CreatedBy
string
Created By.
DefaultPaymentTerm
integer
Default Payment Term.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/businesses" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Name": "",
    "WebAddress": "",
    "CountryId": 0,
    "CurrencyId": 0,
    "SimpleTimeZoneId": 0,
    "DiscountPercentage": 0,
    "DiscountAmount": 0,
    "InvoicingPeriod": 0,
    "LastChargedInvoice": 0,
    "LastChargedTransaction": 0,
    "LastChargedAttendee": 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.
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}