Teams

Update a team

Update a team's attributes

patch/v1/workspaces/{workspace_id}/teams/{team_id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/teams/{team_id}
  • Auth: API key in header api_access_token

Request body

namestring

The name of the team

descriptionstring

The description of the team

allow_auto_assignboolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

Example request

{
  "name": "Support Team",
  "description": "This is a team of support agents",
  "allow_auto_assign": true
}

Response

Success

idnumber

The ID of the team

namestring

The name of the team

descriptionstring nullable

The description about the team

allow_auto_assignboolean

If this setting is turned on, the system would automatically assign the conversation to an agent in the team while assigning the conversation to a team

account_idnumber

The ID of the account with the team is a part of

is_memberboolean

This field shows whether the current user is a part of the team

Changes

No recorded changes to this operation across all 1 revision of this API.