Skip to main content
This parameter also creates the shared entity folder, using the name set in the value. Entity name has a 64 character limit. In the Embed URL Builder, this is the Embed entity field.

​
Syntax

​
Properties

​
string
An alphanumeric identifier for the user group.

​
Behavior

If a later request leaves out entity or uses a different value, Omni moves the user out of their current entity. To keep the user in their entity, include the same entity on every request. If you include entity without entityAiCreditLimit, Omni removes the credit limit override for all users in that entity. To keep the override, include entityAiCreditLimit on every request that includes entity. See How sessions update embed users for more information.

​
Examples

Example entity