---
agentTools:
  projectIndex: https://docs.voicebase.com/llms.txt
---

# Create or update keyword spotting group

Create or update a keyword spotting group with a set of keywords

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/v3/definition/spotting/groups/{groupId}": {
      "put": {
        "tags": [
          "Definition"
        ],
        "summary": "Create or update keyword spotting group",
        "description": "Create or update a keyword spotting group with a set of keywords",
        "operationId": "createKeywordSpottingGroup",
        "parameters": [
          {
            "name": "groupId",
            "in": "path",
            "description": "The keyword spotting group identifier.",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/VbKeywordGroup"
              }
            }
          },
          "description": "Keyword Spotting Group definition",
          "required": true
        },
        "responses": {
          "200": {
            "description": "SuccessfulOperation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VbKeywordGroup"
                }
              }
            }
          },
          "401": {
            "description": "UnauthorizedException"
          },
          "403": {
            "description": "ForbiddenException"
          },
          "404": {
            "description": "NotFoundException",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VbErrorResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "Authorization": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "VoiceBase V3 API",
    "version": "3.0.31",
    "description": "APIs for speech recognition and speech analytics, powering insights every business needs.",
    "contact": {
      "name": "VoiceBase Support",
      "url": "https://www.voicebase.com/contact-us/",
      "email": "support@voicebase.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    }
  },
  "servers": [
    {
      "url": "https://apis.voicebase.com/"
    }
  ],
  "components": {
    "securitySchemes": {
      "Authorization": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header"
      }
    },
    "schemas": {
      "VbError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "path": {
            "description": "path to source issue",
            "type": "string"
          },
          "error": {
            "type": "string"
          }
        }
      },
      "VbMessage": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "path": {
            "description": "path to source issue",
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "VbErrorResponse": {
        "type": "object",
        "x-voicebase-extension": true,
        "properties": {
          "status": {
            "type": "integer",
            "format": "int32",
            "description": "This is the HTTP Status Code."
          },
          "errors": {
            "description": "Is this Internal Server Errors (5xx)?",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VbError"
            }
          },
          "warnings": {
            "description": "Is this User Data Errors (4xx)?",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/VbMessage"
            }
          },
          "reference": {
            "type": "string",
            "description": "A unique reference number identifying the request."
          }
        }
      },
      "VbKeywordGroup": {
        "type": "object",
        "x-voicebase-extension": true,
        "properties": {
          "groupName": {
            "type": "string"
          },
          "dateCreated": {
            "type": "string",
            "format": "date-time",
            "description": "keywordGroup creation timestamp."
          },
          "dateModified": {
            "type": "string",
            "format": "date-time",
            "title": "Date Modified",
            "description": "The last date the keywordGroup was updated on."
          },
          "keywords": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 96,
      "1": 203,
      "2": 228,
      "3": 227,
      "4": 43,
      "5": 110,
      "6": 67,
      "7": 0,
      "8": 76,
      "9": 213,
      "10": 59,
      "11": 137
    }
  }
}
```