Skip to main content
POST
/
api
/
apps
/
installedapplications
Create InstalledApplication
curl --request POST \
  --url https://spaces.nexudus.com/api/apps/installedapplications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ApplicationId": 123,
  "BusinessId": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
An InstalledApplication represents a third-party or internal application that has been installed and configured for a specific business location.

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 InstalledApplication-Create role.

Request Body

Required Fields

ApplicationId
integer
required
ID of the application linked to this record.
BusinessId
integer
required
ID of the business linked to this record.

Optional Fields

RequiresApproval
boolean
Whether requires approval is enabled.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/apps/installedapplications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "ApplicationId": 0,
    "BusinessId": 0
}'

Response

200

Status
integer
HTTP status code. 200 on success.
Message
string
A human-readable message confirming the creation.
Value
object
Contains the Id of the newly created record.
WasSuccessful
boolean
true if the installedapplication was created successfully.
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "InstalledApplication was successfully created.",
  "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
}