For the complete documentation index, see llms.txt. This page is also available as Markdown.

Topic preferences

The Batch Web SDK allows you to:

  • Add or remove topic preferences from a user profile (the profile is created automatically if it doesn’t already exist).

  • Partially update topic preferences within a user profile.

Requires SDK 4.3+

Here’s how to update topic preferences:

batchSDK(async api => {
    const profile = await api.profile();
    await profile.edit(editor => {
      editor.setTopicPreferences(["technology", "finance"]) // null to erase
      // Alternatively, partially update them with:
      editor.addToTopicPreferences(["investing"])
      editor.removeFromTopicPreferences(["travel"])
    })
});
batchSDK(api => {
    api.profile().then(profile => {
      profile.edit(editor => {
          editor.setTopicPreferences(["technology", "finance"]) // null to erase
          // Alternatively, partially update them with:
          editor.addToTopicPreferences(["investing"])
          editor.removeFromTopicPreferences(["travel"])
      })
    })
});

Note: Topics must be a valid List of String not longer than 25 items. String should be made of letters, numbers or underscores ([a-z0-9_]) and can't be longer than 300 characters.

Topics are deduplicated and follows a last-wins rule: if a value already exists in the array, it is moved to the end. Size limits are enforced after deduplication.

Last updated