Namespaces

Many entities in the Benefits Programs APIs include a required namespace property. You must use the same namespace for all entities created by your app or directly by your site. Namespaces allow you to distinguish between entities that you created and entities that other apps created.

For example, let's say you want to retrieve all items with a specific category. You can call Query Items and filter by category. However, there may be another app that created items and used the same category name. To ensure that you're retrieving only the items that you created, you can also filter by namespace.

The following entities include a required namespace field:

Note: Many entities contain an extendedFields object which contains a namespaces field. This is different to the namespace you use for your benefit programs. Learn more about extended fields.

Did this help?