Skip to main content
PATCH
/
api
/
team
/
{teamId}
Update Team
curl --request PATCH \
  --url https://app.replay.sale/api/team/{teamId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "Default",
  "useTurnConnection": true
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "type": "Default",
  "useTurnConnection": true
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your API key from your company settings.

Path Parameters

teamId
string<uuid>
required

The UUID of the team to update

Body

application/json

At least one field must be provided. Only the specified fields will be updated.

name
string

Updated name of the team

description
string | null

Updated description of the team

type
enum<string>

Updated type of team

Available options:
Default,
Integration,
LeadGen
useTurnConnection
boolean

Whether to use TURN connection for this team

Response

Successfully updated team

id
string<uuid>
required

Unique identifier for the team

name
string
required

Name of the team

companyId
string<uuid>
required

ID of the company this team belongs to

createdAt
string<date-time>
required

When the team was created

description
string | null

Description of the team

type
enum<string>

Type of team

Available options:
Default,
Integration,
LeadGen
useTurnConnection
boolean

Whether to use TURN connection for this team