Skip to main content
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>"
}
'
{
  "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

BusinessId
integer
required
ID of the business linked to this record.
Name
string
required
Team name.

Optional Fields

Description
string
Team description.
TunnelPrivateGroupId
string
Tunnel private group ID.
TeamMembers
integer[]
List of team members linked to this record.
TeamAdministrators
integer[]
List of team administrators linked to this record.
CreateSingleInvoiceForTeam
boolean
Create a single invoice for the team.
UseSpecialPrices
boolean
Use special prices.
PayingMemberId
integer
ID of the paying member linked to this record.
DefaultMemberTariffId
integer
ID of the default member tariff linked to this record.
MaxTeamMemberCount
number
Maximum team member count.
TransferCreditsToPayingMember
boolean
Transfer credits to paying member.
ShareTimePasses
boolean
Share time passes.
ShareExtraServices
boolean
Share extra services.
ShareBookingCredit
boolean
Share booking credit.
DiscountExtraServices
number
Discount for extra services.
DiscountTimePasses
number
Discount for time passes.
DiscountCharges
number
Discount for charges.
DiscountTariffs
number
Discount for tariffs.
ProfileSummary
string
Profile summary.
ProfileTags
string
Profile tags.
ProfileWebsite
string
Profile website.
Google Maps link.
ProfileIsPublic
boolean
Whether the profile is public.
HasCommunityGroup
boolean
Whether the team has a community group.
NewTeamLogoUrl
string
URL of a new file to upload as the team logo.
ClearTeamLogoFile
boolean
Set to true to remove the current team logo file.
NewTeamImage1Url
string
URL of a new file to upload as the team image1.
ClearTeamImage1File
boolean
Set to true to remove the current team image1 file.
NewTeamImage2Url
string
URL of a new file to upload as the team image2.
ClearTeamImage2File
boolean
Set to true to remove the current team image2 file.
NewTeamImage3Url
string
URL of a new file to upload as the team image3.
ClearTeamImage3File
boolean
Set to true to remove the current team image3 file.
Twitter
string
Twitter handle.
Facebook
string
Facebook URL.
Linkedin
string
LinkedIn URL.
Skype
string
Skype handle.
Telegram
string
Telegram handle.
Github
string
GitHub URL.
Pinterest
string
Pinterest URL.
Flickr
string
Flickr URL.
Instagram
string
Instagram URL.
Vimeo
string
Vimeo URL.
Tumblr
string
Tumblr URL.
Blogger
string
Blogger URL.
DisableAttendanceDashboard
boolean
Disable attendance dashboard.
ExtraServices
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": ""
}'

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

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
}