Skip to main content

Importance of API Group Permissions in Mobile SDK

Updated

Why are they important

If the API Group used by the Mobile SDK does not have the required set / get permissions, the Mobile SDK may be implemented correctly in the app, but still fail to work properly. This can affect event tracking, push token registration, push delivery, and SDK data retrieval.

If Mobile SDK API Group permissions are not configured correctly, customers may face:

  • No mobile SDK events

  • No push token data

  • Push notifications are not delivered

  • Missing delivered or clicked tracking

  • Mobile SDK read/data features not working

Missing set Permissions can cause

  • Mobile SDK events not tracked: core events such as installation, session_start, session_end, campaign, and banner may not be written to the project.

  • Push token missing: push token data  notification_state may not appear in the profile or event stream.

  • Push notifications not delivered: if the token is not written successfully, the platform has no valid token to deliver them.

  • Delivered and clicked tracking missing: mobile push delivered and clicked statuses are tracked from the app via the SDK, so they may not be recorded if campaign event tracking is blocked.

  • Push self-check failing:  self-check depends on successful token tracking and push setup validation.

Missing get permissions can cause

  • Some Mobile SDK read features may not work — this mainly affects Mobile SDK read flows such as consent category fetching, recommendation fetching, and other Mobile SDK read endpoints, depending on the setup.

Push-related customer properties to allow

In Project settings > Access management > API > Group permissions > Customer properties, enable:

  • apple_push_notification_authorized

  • apple_push_notification_id

  • google_push_notification_id

  • huawei_push_notification_id

How to set up API Group permissions

  1. Go to Project settings > Access management > API.

  2. Open the API Group used by the Mobile SDK.

  3. In Group permissions, allow the required permissions under:

    • Events — to let the Mobile SDK track required event types

    • Customer properties — to let the Mobile  SDK write push-related properties

    9383935-api-group-permissions.png

  4. Save the changes and make sure the same API Group token is used in the SDK configuration.