userAttributes

Applies user attributes to the embed user. In the Embed URL Builder, this is the User attributes field.

Syntax

userAttributes={"<user_attribute_reference>": "<value>", ...}

Properties

object

An object containing user attributes, specified as "<user_attribute_reference>": "<value>".

Examples

With and without encoding

v1 payload
v0 (legacy) payload

In the v1 signed payload format, send the value as JSON:

v1 payload

userAttributes={"country":"Townsville", "associated_ids":[9,10,11], "omni_user_timezone":"America/New_York"}

In the legacy v0 format, stringify and URL encode the value before sending:

v0 (legacy) payload

userAttributes=%7B%22country%22%3A%22Townsville%22%2C%20%22associated_ids%22%3A%5B9%2C10%2C11%5D%2C%20%22omni_user_timezone%22%3A%22America%2FNew_York%22%7D

Manage AI credit limits

Use the omni_ai_credit_limit user attribute to set an individual user credit limit for the user.

Set a credit limit
Unlimited credits
Remove credit limit

Set the omni_ai_credit_limit value to a number to limit the user to that number of credits:

v1 payload

userAttributes={"omni_ai_credit_limit":40}

Set the omni_ai_credit_limit value to unlimited or null to allow the user to use unlimited credits:

v1 payload

userAttributes={"omni_ai_credit_limit":"unlimited"}

To remove a user’s credit limit, omit the omni_ai_credit_limit key from the userAttributes parameter. This will remove the user-specific setting and apply the organization-level user default instead.

Getting started

Setup

App customization

Events & interactivity

Admin

Syntax

Properties

Examples

With and without encoding

Manage AI credit limits

​Syntax

​Properties

​Examples

​With and without encoding

​Manage AI credit limits

Syntax

Properties

Examples

With and without encoding

Manage AI credit limits