Skip to main content
PUT
Update Team
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 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[]
The added team members value for this team.
integer[]
The removed team members value for this team.
integer[]
List of team administrators linked to this record.
integer[]
The added team administrators value for this team.
integer[]
The removed team administrators value for this team.
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.
boolean
Share time passes.
boolean
Share extra services.
boolean
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.
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.
integer[]
The added extra services value for this team.
integer[]
The removed extra services value for this team.

Code Examples

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

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.
boolean
false when the request fails validation.
Example Response