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

Request Body

Required Fields

Id
integer
required
The Id of the Application record to update.
DeveloperId
integer
required
Developer Id.
Name
string
required
Display name of the application.
ShortDescription
string
required
Brief summary of the application shown in listing views.
InstallUrl
string
required
URL that Nexudus calls when a location installs this application.

Optional Fields

Published
boolean
Whether the application is published and available for installation.
SecretKey
string
Secret key used to authenticate API calls from the application.
Description
string
Full description of the application shown on the detail page.
RequiredRoles
integer[]
Required Roles.
AddedRequiredRoles
integer[]
Added Required Roles.
RemovedRequiredRoles
integer[]
Removed Required Roles.

Code Examples

curl -X PUT \
  "https://spaces.nexudus.com/api/apps/applications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeveloperId": 0,
    "Name": "",
    "ShortDescription": "",
    "InstallUrl": "",
    "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 application was updated successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "Application 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
}