Create Application

POST

api

apps

applications

Create Application

curl --request POST \
  --url https://spaces.nexudus.com/api/apps/applications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "DeveloperId": 123,
  "Name": "<string>",
  "ShortDescription": "<string>",
  "InstallUrl": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/apps/applications"

payload = {
    "DeveloperId": 123,
    "Name": "<string>",
    "ShortDescription": "<string>",
    "InstallUrl": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DeveloperId: 123,
    Name: '<string>',
    ShortDescription: '<string>',
    InstallUrl: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/apps/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

An Application represents a third-party application that can be installed as an add-on in a Nexudus account. Each application is owned by a developer and identified by a unique ApplicationKey and SecretKey pair. The InstallUrl is the endpoint Nexudus calls when a location installs the application.

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

Request Body

Required Fields

integer

required

ID of the developer linked to this record.

string

required

Display name of the application.

string

required

Brief summary of the application shown in listing views.

string

required

URL that Nexudus calls when a location installs this application.

Optional Fields

boolean

Whether the application is published and available for installation.

string

Secret key used to authenticate API calls from the application.

string

Full description of the application shown on the detail page.

integer[]

List of required roles linked to this record.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/apps/applications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "DeveloperId": 0,
    "Name": "",
    "ShortDescription": "",
    "InstallUrl": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/apps/applications',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      DeveloperId: 0,
      Name: '',
      ShortDescription: '',
      InstallUrl: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/apps/applications',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'DeveloperId': 0,
        'Name': '',
        'ShortDescription': '',
        'InstallUrl': ''
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the application was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Application 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

string

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

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

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

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update ApplicationUpdate an existing Application record.

Create Application

curl --request POST \
  --url https://spaces.nexudus.com/api/apps/applications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "DeveloperId": 123,
  "Name": "<string>",
  "ShortDescription": "<string>",
  "InstallUrl": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/apps/applications"

payload = {
    "DeveloperId": 123,
    "Name": "<string>",
    "ShortDescription": "<string>",
    "InstallUrl": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    DeveloperId: 123,
    Name: '<string>',
    ShortDescription: '<string>',
    InstallUrl: '<string>'
  })
};

fetch('https://spaces.nexudus.com/api/apps/applications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400