Developer DiscussionDeveloper BlogAtlas
API Reference

Update author metadata

put https://api.app.lithium.com/bots/v3/authors/attributes (COPY)

Use the Bot v3 API to have the bot update author metadata properties

Details

Update author CRM attributes with a PUT request to /bots/v3/authors.

{
  "type": "author_update",
  "coordinate": {
    "companyKey": "<company-key>",
    "networkKey": "brandmessenger",
    "externalId": "<external-id>",
    "messageId": "<message-id>",
    "botId": "<bot-id>",
    "scope": "PRIVATE"
  },
  "author": {
    "id": "<author-id>"
  },
  "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"
  },
  "updatedName": "Anonymous QA 50ec-90a5"
}

Author Properties JSON payload fields

type

The payload type. Always author.

coordinate

A Coordinate object. This is object contains details about the bot and the message in context. It is used by Khoros Care.

author

An Author object representing the message author on the source channel.

properties

An Properties object representing author-specific metadata that you would like to have displayed in the author's profile within Khoros Care.

updatedName

A display name to appear at the top of the author's profile in Care. This does not change or affect the author's full name stored in the Author object.

Language