Skip to main content
PUT
/
api
/
sys
/
businessredirections
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
Updates an existing BusinessRedirection 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 BusinessRedirection-Edit role.

Request Body

Required Fields

Id
integer
required
The Id of the BusinessRedirection record to update.
BusinessId
integer
required
Business Id.
SourceURL
string
required
Source URL path to redirect from.
DestinationURL
string
required
Destination URL to redirect to.

Optional Fields

Active
boolean
Whether the redirect is currently active.
ActiveFrom
string
Date and time from which the redirect becomes active.
ActiveTo
string
Date and time after which the redirect is no longer active.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/sys/businessredirections" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "SourceURL": "",
    "DestinationURL": "",
    "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 businessredirection was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "BusinessRedirection 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": "SourceURL: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "SourceURL"
    }
  ],
  "WasSuccessful": false
}