Update Team

PUT

api

spaces

teams

Update Team

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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>"
    }
  ]
}

Updates an existing Team 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 Team-Edit role.

Request Body

Required Fields

integer

required

The Id of the Team record to update.

integer

required

ID of the location this team belongs to.

string

required

Required team name, unique within the location and limited to 254 characters.

Optional Fields

string

Optional internal description of the team.

string

Optional private network or VLAN group identifier used by supported access-control and WiFi integrations.

integer[]

List of customer IDs belonging to this team; the paying customer must be included when consolidated invoices or credit pooling is enabled.

integer[]

IDs added to the TeamMembers relationship..

integer[]

IDs removed from the TeamMembers relationship..

integer[]

List of customer IDs designated as team administrators.

integer[]

IDs added to the TeamAdministrators relationship..

integer[]

IDs removed from the TeamAdministrators relationship..

boolean

Whether the designated paying customer receives consolidated invoices for the other team members; requires a paying customer who belongs to the team.

boolean

Whether members use the designated paying customer’s special prices.

integer

ID of the customer who pays for this team; required and must be a team member when consolidated invoices or credit pooling is enabled.

integer

Optional ID of the plan proposed as the default for team members when a customer is added to the team by a team administrator..

number

Optional maximum number of customers for this team.

boolean

Whether team members’ credits are pooled with the paying customer; requires a paying customer and supports teams of up to 50 customers.

Whether team members share passes through the paying customer; with credit pooling enabled, their combined included passes cannot exceed 500.

Whether team members share time credits and printing credits through the paying customer.

Whether team members can use the paying customer’s booking credit for their bookings.

number

Optional percentage discount on booking rates; the highest applicable team or plan discount is used.

number

Optional percentage discount on passes; the highest applicable team or plan discount is used.

number

Optional percentage discount on one-off charges; the highest applicable team or plan discount is used.

number

Optional percentage discount on plans; the highest discount configured on any of the customer’s teams is used.

string

Optional HTML profile summary displayed in the public team directory.

string

Optional public-directory tags used to find this team, limited to 254 characters.

string

Optional website URL displayed on the public team profile, limited to 254 characters.

string

Optional Google Maps URL displayed on the public team profile, limited to 1024 characters.

boolean

Whether this team’s profile can appear in the public directory.

boolean

Whether Nexudus automatically creates and maintains a discussion-board community group for this team.

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

Optional X or Twitter profile URL, limited to 254 characters.

string

Optional Facebook profile URL, limited to 254 characters.

string

Optional LinkedIn profile URL, limited to 254 characters.

string

Optional Skype handle or URL, limited to 254 characters.

string

Optional Telegram handle or URL, limited to 254 characters.

string

Optional GitHub profile or organization URL, limited to 254 characters.

string

Optional Pinterest profile URL, limited to 254 characters.

string

Optional Flickr profile URL, limited to 254 characters.

string

Optional Instagram profile URL, limited to 254 characters.

string

Optional Vimeo profile URL, limited to 254 characters.

string

Optional Tumblr profile URL, limited to 254 characters.

string

Optional Blogger profile URL, limited to 254 characters.

boolean

Whether to hide this team’s attendance dashboard from its customers.

integer[]

List of booking rate IDs linked to this team.

integer[]

IDs added to the ExtraServices relationship..

integer[]

IDs removed from the ExtraServices relationship..

Code Examples

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

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

const data = await response.json();

import requests

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

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the update.

object

Contains the Id of the updated record.

boolean

true if the team was updated successfully.

array

null on success.

Example Response

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

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 Team

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Id: 123, 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