--- title: "API Access and Permissions" slug: "set-scopes" updated: 2026-07-07T09:07:44Z published: 2026-07-07T09:07:44Z canonical: "docs.xtremepush.com/set-scopes" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt > Use this file to discover all available pages before exploring further. # API Access and Permissions ## Add Client ID To create a client ID, do the following: 1. Go to **Settings** > **Integrations** > **API Integrations**. 2. Click **Create Client ID** and enter a name for the integration. 3. Click save. A **Client ID** is automatically generated for you. ## Set Scopes Select **Set Scopes** for the relevant Client ID to manage its permissions. The tables describe the functionality available for each scope. Each operation includes a checkbox that allows you to enable or disable specific access. All changes to the scope are recorded in the **Updated By** and **Updated Time** columns. ### Common Operations | Scope | Permissions | API Reference | | --- | --- | --- | | Create | - Create an automated campaign or create a campaign to be dispatched immediately - Create a segment that will be associated with your project - Create a list of users that will be associated with your project - Create a new tag or an attribute. | - [Create Campaign](https://docs.xtremepush.com/apidocs/create) - [Create Segment](/v1-api/apidocs/create-segment) - [Create List](/v1-api/apidocs/create-list) - [Create Tag](/v1-api/apidocs/create-1) | | Batch create | Create a batch of new tags or attributes | [Batch Create Tags](/v1-api/apidocs/batch-create) | | Update | - Update a campaign that has already been created - Update an existing segment - Update an existing user list | - [Update Campaign](/v1-api/apidocs/update) - [Update Segment](/v1-api/apidocs/update-segment) - [Update List](/v1-api/apidocs/update-list) | | Delete | - Delete a segment - Delete a user list | - [Segment](/v1-api/apidocs/delete-segment) - [List](/v1-api/apidocs/delete-list) | | List | - List created campaigns - List the devices using your application - List created user profiles - List segments associated with your project - List all lists associated with your project - List all list items - List information of push actions related to campaigns - List information of the push actions sent to individual devices or profiles - List subscription statuses from user profiles - List profile attribute values from user profiles - List consent preferences information for a user profile - List the tags that have been reported in your project - List information on devices hitting tags - List information on attributes associated with users or devices - Lists the tasks associated with your project - List promotions synced from connected bonus engines - List OTP History records based on specific input parameters | - [Campaign List](/v1-api/apidocs/list) - [Device List](/v1-api/apidocs/list-2) - [Profile List](/v1-api/apidocs/list-1) - [Segment List](/v1-api/apidocs/list-segments) - [List List](/v1-api/apidocs/list-lists) - [List Item](/v1-api/apidocs/list-list-items) - [List Push](/v1-api/apidocs/list-push-notifications) - [List Push Devices](/v1-api/apidocs/list-push-devices) - [List Profile Subscription](/v1-api/apidocs/profile-subscription) - [List Profile Attribute](/v1-api/apidocs/profile-attribute) - [List Profile Consent Preference](/v1-api/apidocs/profile-consent-preference) - [List tag](/v1-api/apidocs/list-3) - [List tag hit](/v1-api/apidocs/list-hit) - [List attribute client](/v1-api/apidocs/list-attribute-client) - [List task](/v1-api/apidocs/list-tasks) - [List Promotions](/v1-api/apidocs/list-promotions) - [List OTP History](/v1-api/apidocs/otp-history-list) | | Info | - Get information on a single campaign - Get details on a single device using your application - Get information on a user profile - Get information on a single segment - Get information on a single user list - Get information on asynchronous data tasks such as imports or deletions - Get information on a single push notification action - Get information on OTP logs. | - [Campaign Info](/v1-api/apidocs/info) - [Device info](/v1-api/apidocs/info-2) - [Profile info](/v1-api/apidocs/info-1) - [Segment info](/v1-api/apidocs/info-segment) - [List Info](/v1-api/apidocs/info-list) - [Task Info](/v1-api/apidocs/info-task) - [Message Info](/v1-api/apidocs/info-push) - [OTP Info](/v1-api/apidocs/otp-history-info) | ### Campaign Operations | Scope | Permissions | API Reference | | --- | --- | --- | | Send | Send a single campaign | [Send](/v1-api/apidocs/send) | | Execute | Execute a campaign | [Execute](/v1-api/apidocs/execute) | | Start | Start a paused/stopped campaign | [Start](/v1-api/apidocs/start) | | Stop | Stop and active campaign | [Stop](/v1-api/apidocs/stop) | | Schedule | Schedule a campaign | | | Expire Inbox | Expire an entire inbox campaign that is currently live | [Expire Inbox](/v1-api/apidocs/expire-inbox) | | Remove Inbox | Remove an inbox message that has already been sent | [Remove Inbox](/v1-api/apidocs/remove-inbox) | | Cancel Journey | Cause a user or a list of users to finish a multi-stage journey, preventing them from receiving more messages | [Cancel Journey](/v1-api/apidocs/cancel-journey) | ### Hit Operations | Scope | Permissions | API Reference | | --- | --- | --- | | Tag | - Add a tag or update an attribute when an event occurs or an attribute changes outside your app - Add tags or update attributes when an event occurs or an attribute changes outside your app | - [Hit Tag](/v1-api/apidocs/hit) - [Hit Tags](/v1-api/apidocs/hit-tags) | | Event | - Send a realtime event to Xtremepush when an event occurs on a backend system - Send realtime events to Xtremepush in batch when events occurs on a backend system | - [Hit Event](/v1-api/apidocs/hit-event) - [Batch Hit](/v1-api/apidocs/batch-hit) | ### Other Operations | Scope | Permissions | API Reference | | --- | --- | --- | | Import | - Create new user profiles and/or set attributes for these profiles - import/update the values of the list of users that will be associated with your project. - Add/remove recipients to/from a suppression list. | - [Import Profile](/v1-api/apidocs/import) - [Import Lists](/v1-api/apidocs/import-list) - [Import Suppression Lists](/v1-api/apidocs/import-suppression-list) | | Export | Trigger a background task to export device or profile data for a specific segment | [Trigger Segment Expor](/v1-api/apidocs/trigger-segment-export)t | | Analytics | - Return information on new users over a given time period - Return information on total sessions over a given time period - Return information on unique sessions over a given time period - Return information on total session time over a given time period, the unit is seconds - Return information on average session time over a given time period, the unit is seconds - Returns new users, total sessions, unique sessions, total sessions time and avg session time in one request - Returns statistics from all campaigns or from particular campaigns - Returns information on location entries over a given time period | - [New Users](/v1-api/apidocs/new-users) - [Total Sessions](/v1-api/apidocs/total-sessions) - [Unique Sessions](/v1-api/apidocs/unique-sessions) - [Total Sessions Time](/v1-api/apidocs/total-sessions-time) - [Average Sessions Time](/v1-api/apidocs/average-session-time) - [Statistics](/v1-api/apidocs/statistics) - [Campaign Stats](/v1-api/apidocs/campaign-stats) - [Location hits](/v1-api/apidocs/location-hits) | | Download File | Retrieve a specific file using its unique file identifier. | [Download File by ID](/v1-api/apidocs/download-file-by-id) | | Integration Actions | - Create and send one-time passwords (OTPs) to users for secure authentication. - Send your own OTP to your users - Validate one-time passwords (OTPs) entered by users against previously generated and stored OTPs. - Subscribe a customer to real-time sports updates - Unsubscribe a customer from real-time sports updates | - [OTP Generate](/v1-api/apidocs/otp-generate) - [OTP Execute](/v1-api/apidocs/otp-execute) - [OTP Verify](/v1-api/apidocs/otp-verify) - [Follow](/v1-api/apidocs/follow-sport-updates) - [Unfollow](/v1-api/apidocs/unfollow-sport-updates) | | Data Actions | - Delete all personal data for a user profile and devices associated to the user profile. - Delete device personal data | - [Delete Personal Data](/v1-api/apidocs/delete-personal-data) - [Delete Device Personal Data](/v1-api/apidocs/delete-device-personal-data) |