Properties object

The properties object is used in the PUT /bots/v3/authors endpoint to update metadata information that appears in the author profile in Care. This information provides contextual data to the agent, as well as additional organizational metadata you can use to serve end users better.

This metadata includes standard contextual information such as an author's gender and location, but it can also contain data useful for troubleshooting and data organization.

Each field in the object has a string value type.

{
  ...
  "properties": {
    "Gender": "Male",
    "Location": "us-north-1",
    "City": "Chicago",
    "Language": "en-UK",
    "Country": "USA",
    "State": "Il",
    "Page URL": "example.examplecorp.com",
    "IP Address": "1.2.3.4",
    "Page Title": "Example Page",
    "ruleId": "rule1",
    "widgetId": "widget1",
    "webUiKey": "webkey1",
    "User-Agent": "AgentExample",
    "Platform": "Web"
  }
  ...
}

📘

NOTE

The values for each of these fields are examples only, and can be formatted or utilized in a way that fits your company's needs. The properties object is primarily used to provide contextual information to the agent or support staff about the author.