Create Team

POST

api

spaces

teams

Create Team

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

import requests

url = "https://spaces.nexudus.com/api/spaces/teams"

payload = {
    "BusinessId": 123,
    "Name": "<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({BusinessId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/teams', 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>"
    }
  ]
}

A Team groups customers (coworkers) together for billing, access control, and administrative purposes. Teams can share invoicing, have a designated team leader, and be assigned dedicated resources such as desks or offices.

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

Request Body

Required Fields

integer

required

ID of the business linked to this record.

string

required

Team name.

Optional Fields

string

Team description.

string

Tunnel private group ID.

integer[]

List of team members linked to this record.

integer[]

List of team administrators linked to this record.

boolean

Create a single invoice for the team.

boolean

Use special prices.

integer

ID of the paying member linked to this record.

integer

ID of the default member tariff linked to this record.

number

Maximum team member count.

boolean

Transfer credits to paying member.

Share time passes.

Share extra services.

Share booking credit.

number

Discount for extra services.

number

Discount for time passes.

number

Discount for charges.

number

Discount for tariffs.

string

Profile summary.

string

Profile tags.

string

Profile website.

string

Google Maps link.

boolean

Whether the profile is public.

boolean

Whether the team has a community group.

string

URL of a new file to upload as the team logo.

boolean

Set to true to remove the current team logo file.

string

URL of a new file to upload as the team image1.

boolean

Set to true to remove the current team image1 file.

string

URL of a new file to upload as the team image2.

boolean

Set to true to remove the current team image2 file.

string

URL of a new file to upload as the team image3.

boolean

Set to true to remove the current team image3 file.

string

Twitter handle.

string

Facebook URL.

string

LinkedIn URL.

string

Skype handle.

string

Telegram handle.

string

GitHub URL.

string

Pinterest URL.

string

Flickr URL.

string

Instagram URL.

string

Vimeo URL.

string

Tumblr URL.

string

Blogger URL.

boolean

Disable attendance dashboard.

integer[]

List of extra services linked to this record.

Code Examples

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

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

const data = await response.json();

import requests

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

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 team was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "Team 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 TeamUpdate an existing Team record.

Create Team

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

import requests

url = "https://spaces.nexudus.com/api/spaces/teams"

payload = {
    "BusinessId": 123,
    "Name": "<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({BusinessId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/spaces/teams', 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