v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Teams

Update team

Partially update a team. Only provided fields will be updated.

patch/teams/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Request body

namestring

Team name

keystring nullable

Client-defined reference identifier

Example request

{
  "name": "Sales Team - West Coast",
  "key": "ERP-TEAM-WEST",
  "users": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000"
    },
    {
      "key": "ERP-USER-12345"
    }
  ]
}

Response

Team updated successfully

object'TEAM'

Object type identifier

idstring uuid required

Unique team identifier

namestring required

Team name

keystring nullable

Client-defined reference identifier for this team

createdAtstring date-time required

Timestamp when team was created

updatedAtstring date-time required

Timestamp when team was last updated

deletedAtstring date-time nullable

Timestamp when team was soft-deleted (null if active)

Example response

{
  "object": "TEAM",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Team - West Coast",
  "key": "ERP-TEAM-WEST",
  "users": [
    {
      "object": "USER",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "email": "john.doe@example.com",
      "name": "John Doe",
      "phone": "+1-555-123-4567",
      "phoneExt": "123",
      "roles": [
        "CUSTOMER_REP",
        "ADMIN"
      ],
      "key": "ERP-USER-12345",
      "datUsername": "johndoe_dat",
      "mcpUsername": "johndoe_mcp",
      "avatarId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "createdAt": "2025-01-15T10:00:00Z",
      "updatedAt": "2025-01-15T14:30:00Z"
    }
  ],
  "createdAt": "2025-01-15T10:00:00Z",
  "updatedAt": "2025-01-15T14:30:00Z"
}