Update Team

put

https://api.whippy.co/v1/teams/{id}

A request to this endpoint can be used to:

set/update name
set/update the assignment_method
set/update the team's locations

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Team ID

Body Params

Team Update Params

Update Team Params schema

assignment_method

string

enum

Defaults to manual

The team's assignment method. There are three options - "manual", "round_robin", "balanced".

Manual - Conversations are not automatically assigned
Round Robin - Conversations are assigned to teammates in sequential order
Balanced - Conversations are assigned to teammates with the fewest active conversations

Allowed:

color

string

Color

description

string

Description

emoji

string

Emoji

locations

array of strings

List of Location IDs

locations

name

string

[a-zA-Z][a-zA-Z0-9_]+

Team name

team_members

array of integers

Optional list of organization user IDs to add as team members. On update, this replaces the team's full member set. Every ID must belong to the organization, otherwise the request is rejected and nothing is changed.

team_members

Responses

Callback

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Team Update Response

400Bad Request

401Not Authenticated Response

404Not Found

422Unprocessable Content Response