API Access and Permissions

Add Client ID

To create a client ID, do the following:

Go to Settings > Integrations > API Integrations.
Click Create Client ID and enter a name for the integration.
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 Create Segment Create List Create Tag
Batch create	Create a batch of new tags or attributes	Batch Create Tags
Update	Update a campaign that has already been created Update an existing segment Update an existing user list	Update Campaign Update Segment Update List
Delete	Delete a segment Delete a user list	Segment 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 Device List Profile List Segment List List List List Item List Push List Push Devices List Profile Subscription List Profile Attribute List Profile Consent Preference List tag List tag hit List attribute client List task List Promotions List OTP History
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 Device info Profile info Segment info List Info Task Info Message Info OTP Info

Campaign Operations

Scope	Permissions	API Reference
Send	Send a single campaign	Send
Execute	Execute a campaign	Execute
Start	Start a paused/stopped campaign	Start
Stop	Stop and active campaign	Stop
Schedule	Schedule a campaign
Expire Inbox	Expire an entire inbox campaign that is currently live	Expire Inbox
Remove Inbox	Remove an inbox message that has already been sent	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

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 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 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 Import Lists Import Suppression Lists
Export	Trigger a background task to export device or profile data for a specific segment	Trigger Segment Export
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 Total Sessions Unique Sessions Total Sessions Time Average Sessions Time Statistics Campaign Stats Location hits
Download File	Retrieve a specific file using its unique file identifier.	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 OTP Execute OTP Verify Follow Unfollow
Data Actions	Delete all personal data for a user profile and devices associated to the user profile. Delete device personal data	Delete Personal Data Delete Device Personal Data

Documentation Index