Update Trackers

🚧

In Beta

This feature is in Beta. If you have questions or comments, email [email protected].

We're working to improve this content! :star:

To update an existing Tracker, send a PUT Tracker API request using the Management API. This updates a Tracker entity against the trackerId which can be used by other APIs.

You can also create, view, edit, and delete Trackers using the Trackers Management UI. To access this feature, log in to the Symbl Platform and see Management API.

API Endpoint

PUT https://api.symbl.ai/v1/manage/tracker/{trackerId}

Request Headers

Header NameRequiredDescription
AuthorizationYesBearer <token> The token you get after completing the Authenticate process.
Content-TypeYesapplication/json
x-api-keyNoDEPRECATED.

Request Parameter

Include the request parameter trackerId, the unique identifier of the Tracker to be updated:

Sample Request Body

{
    "id": "4476908732794496",
    "name": "Promotion Mention",
    "vocabulary": [
      "A flat 10 20 percent sale is",
      "Flash sale is available right now",
      "Lifestyle discount is available"
    ]
}

Request Body Parameters

ParameterDescription
idThe id is the unique identifier of the Tracker entity being updated.
nameThe name acts as a unique identifier assigned to the Tracker. It is case-sensitive, which means that a Tracker can be created with the same name but with different cases.
vocabularyThe vocabulary contains a set of phrases/keywords which signify the context of the Tracker. In other words, these are a set of sentences that are commonly used while talking about the said Tracker in different contexts.

The vocabulary cannot have duplicate phrases/keywords.

This API accepts a request body size up to 1MB. Sizes exceeding this limit return the error 413 - Request Entity Too Large.

Sample Response Body

{
   "tracker":{
      "id":"4476908732794496",
      "name":"Promotion Mention",
      "vocabulary":[
         "A flat 10 20 percent sale is",
         "Flash sale is available right now",
         "Lifestyle discount is available",
         "We have a special promotion going on if you book this before",
         "I can offer you a discount of 10 20 percent you being a new customer for us",
         "We have our month special this month",
         "We have a sale right now on"
      ]
   }
}

tracker

This is the wrapper JSON Object which also contains a unique id associated with the Tracker entity that can be later used to instruct Symbl APIs to help track keywords and phrases in the conversation.

Error Codes

If the operation fails, it returns one of the following error codes:

Error CodeDescriptionResolution
409 - ConflictThe 409 response code specifies that the Tracker with that specific name already exists.Modify the name of the Tracker or update the name of the existing Tracker with that name to resolve the error.
404 - Not FoundThe 404 response code specifies that the Tracker with that specific trackerId does not exist.Check the trackerId and ensure that it is valid and exists.
429 - Too many requestsThe 429 response code specifies that the number of concurrent requests surpassed the limit for the API (which is 1 API call at a time).Ensure that your system doesn’t make concurrent API calls that exceed this limit.
400 - Bad RequestThe 400 response code specifies that the request body or the parameters have incorrect key names or their values have types that are different than the ones expected.Please read the message returned in the response to fix this error.
413 - Request Entity Too LargeThe 413 response code specifies that the size of the request body exceeds that of the maximum limit the API supports (which is 1 MB).Please ensure that the size of the request body is under this limit to resolve this error.
502 - Bad GatewayThe 502 response code specifies that the server failed to acknowledge the request. This may happen due to multiple reasons.Please reach out to [email protected] if it persists even after multiple attempts.
504 - Gateway TimeoutThe 504 response code specifies that the server failed to respond within the timeout duration.Please reach out to [email protected] if it persists even after multiple attempts.