App Configuration

API methods to configure app platforms
post
/configureApplication for iOS
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures iOS platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 1 for iOS. 
ios_key_management_type
required
string
"manual" (one step) or "auto" (few steps). 
ios_key_file
required
string
Base64-encoded iOS key file content.
ios_key_password
required
string
Password for iOS key file.
ios_gateway
required
string
"0" for sandbox, "1" for production. 
ios_framework
required
string
Possible values: "native", "cordova", "titanium"
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": false,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 1, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari
    "ios_key_management_type": "manual", // "manual" (one step) | "auto" (few steps)
    "ios_key_file": "MIIMY...BAQ==", // base64-encoded iOS key file content
    "ios_key_password": "password",
    "ios_gateway": "1", // "0" (sandbox) | "1" (production)
    "ios_framework": "native" // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
  }
}
​
​
Auto configuration
Step 1 Create an app and provide your Apple ID information.
Request
Response
Request
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 1,
    "ios_key_management_type": "auto",
    "step": "1",
    "ios_apple_id": "xxx@xxxxx.xxx",
    "ios_apple_password": "xxxxxx",
    "ios_framework": "native" // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
  }
}
Response
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "step_data": {
      "teams": {
        "12345ABCDE": {
          "name": "Pushwoosh team",
          "memberid": "XXXXXXXXXX"
        }
      },
      "step": 2 // proceed to step 2
    }
  }
}
Step 2 Select the Team ID.
Request
Response
Request
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 1,
    "ios_key_management_type": "auto",
    "step": "2",
    "ios_apple_id": "xxx@xxxxx.xxx",
    "ios_apple_password": "xxxxxx",
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
    "team_id":"12345ABCDE"
 }
}
Response
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "step_data": {
      "appids": [
        {
          "appIdId": "67890FGHIJ",
          "name": "My Application",
          "appIdPlatform": "ios",
          "prefix": "12345ABCDE",
          "identifier": "com.xxxxxxx.xxxxxxx",
          "isWildCard": false,
          "isDuplicate": false,
          "features": {
            "push": true,
            "iCloud": false,
            "inAppPurchase": true,
            "gameCenter": true,
            "XXXXXXXXXX": false,
            "passbook": false,
            "YYYYYYYYYY": false,
            "dataProtection": ""
          },
          "enabledFeatures": [
            "push",
            "inAppPurchase",
            "gameCenter"
          ],
          "isDevPushEnabled": false,
          "isProdPushEnabled": true
        },
        ...
      ],
      "step": 3 // proceed to step 3
    }
  }
}
Step 3 Select the App Id.
Request
Response
Request
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 1,
    "ios_key_management_type": "auto",
    "step": "3",
    "ios_apple_id": "xxx@xxxxx.xxx",
    "ios_apple_password": "xxxxxx",
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
    "team_id": "12345ABCDE",
    "appid": "67890FGHIJ"
 }
}
Response
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "step_data": {
      "step": 4 // proceed to step 4
    }
  }
}
Step 4 Select the apns_type. Configure the app for Dev or Prod.
Request
Response
Request
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 1,
    "ios_key_management_type": "auto",
    "step": "4",
    "ios_apple_id": "xxx@xxxxx.xxx",
    "ios_apple_password": "xxxxxx",
    "ios_framework": "native", // possible values: "native", "cordova", "titanium", "marmalade", "adobeAir", "corona", "xamarin", "phoneGapBuild", "triggerIO", "unity"
    "team_id": "12345ABCDE",
    "appid": "67890FGHIJ",
    "apns_type": "0" // "0" - configure certificate for Development | "1" - configure certificate for Production
 }
}
Response
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "step_data": {
      "appIdProfiles":[
        {
          "profileId":"KLMNOPQRS1",
          "name":"iOS Team Provisioning Profile: com.xxxxx.xxxxx"
        },
        {
          "profileId":"KLMNOPQRS2",
          "name":"XXXXXXX"
        }
      ],
      "certificates": [
        {
          "value": "PY986727N9",
          "name": "Developer (Expiry Feb 13, 2016)"
        }
      ],
      "step": 5 // proceed to step 5
    }
  }
}
Step 5 Select the certificate and provisioning profile.
Request
Response
Request
{
  "request":{
    "auth":"API_ACCESS_TOKEN",
    "application":"APPLICATION_CODE",
    "device_type":"1",
    "ios_key_management_type":"auto",
    "step":"5",
    "ios_apple_id":"xxx@xxxxx.xxx",
    "ios_apple_password":"xxxxxx",
    "ios_framework": "native", // one of native, cordova, titanium, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIO, unity
    "team_id":"12345ABCDE",
    "appid":"67890FGHIJ",
    "apns_type": "0",
    "auto_update_profile": "1", // "0" - manual profile update | "1" - auto profile update
    "profile": "KLMNOPQRS2",
    "certificate" : "PY986727N9"
  }
}
Response
{
  "status_code": 200,
  "status_message": "OK",
  "response":{
    "providers":{
      "ios":true,
      "android":false,
      "wp7":false,
      "macos":false,
      "blackberry":false,
      "wns":false,
      "adm":false,
      "safari":false
    },
    "needTouchProvProfile":true,   // User choosed to auto-update profile
    "provProfileTouchedSuccessfully":true, // Profile changed on Apple side
    "provProfileUploadSuccessfully":true   // Profile created in Pushwoosh
  }
}
​
post
/configureApplication for Android
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Android platform for the app.  
Request
Response
Request
Body Parameters
auth
required
string
API access token from your Pushwoosh Control Panel.
application
required
string
Pushwoosh app code.
device_type
required
integer
Must be 3 for Android.
android_gcm_api_key
required
string
GCM/FCM Server Key obtained from Firebase Cloud Messaging settings.
android_gcm_sender
required
string
GCM/FCM Sender ID obtained from Firebase Cloud Messaging settings.
android_framework
required
string
Android framework. Possible values: native, cordova, marmalade, adobeAir, corona, xamarin, phoneGapBuild, triggerIo, titanium, unity.
android_fcm_service_account
required
object
JSON private key from your Firebase service account. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": true,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false
    }
  }
}
Refer to the Android configuration guide to learn where to find Firebase project credentials.
For Private Offering subscriptions only.
Example 
Example 
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 3, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "android_gcm_api_key": "AIzaSyA…………….7rM", // Android GCM/FCM API Key
    "android_gcm_sender_id": "4821……4542", // Android GCM/FCM Sender ID
    "android_framework": "native", // see possible values above
    "android_fcm_service_account": INSERT_HERE_JSON_FROM_SERVICE_ACCOUNT      
  }
}
​
​
​
post
/configureApplication for Windows Phone
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Windows Phone platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 5 for Windows Phone. 
wp7_state
optional
string
Possible values: "enabled" or "disabled". 
wp7_type
optional
string
Possible values: "authenticated" or "unauthenticated". 
wp7_cert
optional
string
Required when authenticated. Base64-encoded content of certificate file. 
wp7_key
optional
string
Required when authenticated. Base64-encoded content of key file. 
wp7_ca
optional
string
Required when authenticated. Base64-encoded content of certificate authority file. 
wp7_framework
required
string
WP framework. Possible values: native, phoneGapBuild, marmalade, unity. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": true,
      "request.device_typewp7": true,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false
    }
  }
}
For Private Offering subscriptions only.
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 5, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "wp7_state": "enabled", // optional. Possible values are "enabled" and "disabled", "disabled" will disable the platform 
    "wp7_type": "authenticated", // or "unauthenticated", optional 
    "wp7_cert": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of certificate file
    "wp7_key": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of key file
    "wp7_ca": "iVBORw0KGgoAAAANSUhEUgAABB…", // required when authenticated. Base64-encoded content of certificate authority file
    "wp7_framework": "native" // Possible values: native, phoneGapBuild, marmalade, unity. 
  }
}
​
post
/configureApplication for Mac OS X
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Mac OS X platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel. 
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 7 for Mac OS X. 
macos_key_management_type
required
string
Only "manual" type is available currently. 
macos_cert_file
optional
string
Base64-encoded Mac OS X certificate file content. 
macos_key_file
optional
string
Base64-encoded Mac OS X key file content. 
macos_key_password
optional
string
Key file password.
macos_gateway
required
integer
Push gateway. "0" for sandbox, "1" for production. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": true,
      "wp7": true,
      "macos": true,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 7, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "macos_key_management_type": "manual", 
    "macos_cert_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X certificate file 
    "macos_key_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of Mac OS X key file 
    "macos_key_password": "PASSWORD", // optional. Key file password 
    "macos_gateway": 1 // push gateway. "0" for sandbox or "1" for production 
  }
}
​
post
/configureApplication for Windows 8
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Windows 8 platforms for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel. 
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 8 for Windows. 
wns_psid
required
string
Package security identifier from Windows Store for the app. Starts with "ms-app://". 
wns_secret
required
string
Client Secret from Windows Store for the app. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": true,
      "wp7": true,
      "macos": true,
      "blackberry": true,
      "wns": true,
      "adm": false,
      "safari": false
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 8, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "wns_psid": "ms-app://…", // package security identifier of the app from Windows Store
    "wns_secret": "CLIENT_SECRET" // Windows client secret 
  }
}
​
​
​
post
/configureApplication for Amazon
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Amazon platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 9 for Amazon. 
adm_cid
required
string
Amazon client ID.
adm_secret
required
string
Amazon client secret. 
adm_framework
required
string
Amazon framework. Possible values: native, unity, adobeAir. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": true,
      "android": true,
      "wp7": true,
      "macos": true,
      "blackberry": true,
      "wns": true,
      "adm": true,
      "safari": false
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 9, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "adm_cid": "CLIENT_ID", // Amazon client ID
    "adm_secret": "CLIENT_SECRET", // Amazon Client Secret  
    "adm_framework": "native" // Possible values: native, unity, adobeAir. 
  }
}
post
/configureApplication for Chrome
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Chrome platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh app code.
device_type
required
integer
Must be 11 for Chrome.
chrome_gcm_api_key
required
string
Server Key from Firebase Cloud Messaging settings.
chrome_gcm_project_nu,ber
optional
string
Project number from Firebase general project settings.
chrome_fcm_service_account
required
object
JSON private key from Firebase Service Account.
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "android": true,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false,
      "asha": false,
      "chrome": true
    }
  }
}
Refer to the Chrome configuration guide to learn where to find Firebase project credentials.
For Private Offering subscriptions only.
Example
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 11, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "chrome_gcm_api_key": "AIzaSyA…………….7rM", // GCM/FCM API key for Google Chrome 
    "chrome_gcm_project_number": "557…919", // GCM/FCM project number 
    "chrome_fcm_service_account": INSERT_HERE_JSON_FROM_SERVICE_ACCOUNT
  }
}
​
post
/configureApplication for Safari
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Safari platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 10 for Safari. 
safari_key_management_type
optional
string
Only "manual" type is available currently.
safari_website_name
optional
string
Website name.
safari_allowed_domains
optional
array
Ex: [http://site1.com/", https://site2.com"]
safari_url_template
required
string
Safari URL template formatted as "https://%@".
safari_icon_file
optional
string
Base64-encoded content of 256x256px png file. 
safari_key_file
required
string
Base64-encoded Safari .p12 key file content.
safari_key_password
optional
string
Password to the key file. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "android": false,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": true
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 10, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "safari_key_management_type": "manual", 
    "safari_website_name": "WEBSITE_NAME", // optional 
    "safari_allowed_domains": ["http://site1.com", "https://site2.com"], // optional
    "safari_url_template": "https://%@", 
    "safari_icon_file": "iVBORw0KGgoAAAANSUhEUgAABB…", // optional. Base64-encoded content of 256x256px png file
    "safari_key_file": "MIIMY...BAQ==", // base64-encoded Safari .p12 key file content  
    "safari_key_password": "PASSWORD" // optional. Password to the key file above  
  }
}
​
​
​
post
/configureApplication for Firefox
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Firefox platform for the app. 
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh app code.
device_type
required
integer
Must be 12 for Firefox.
firefox_is_enabled
required
boolean
Enables push notifications for Firefox.
firefox_fcm_sender_id
required
string
Sender ID from Firebase Cloud Messaging settings.
firefox_fcm_api_key
required
string
Server key from Firebase Cloud Messaging settings.
firefox_fcm_service_account
required
object
JSON private key from Firebase Service Account.
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "android": true,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false,
      "asha": false,
      "firefox": true
    }
  }
}
Refer to the Firefox configuration guide to learn where to find Firebase project credentials.
For Private Offering subscriptions only.
Example
Example
{
  "request":{
    "auth": "lZcoO8ZDvg8nIVh6kS6LWHwcRCS13KxarteY41Alv+a96CKEK+CTUwLszZMbWeuYdTC8KgxphbtAHZ6RQ153",
    "application": "1DC69-73EDB",
    "device_type": "12",
    "firefox_is_enabled": true,
    "firefox_fcm_sender_id": "123123123", // optional for fastpushes
    "firefox_fcm_api_key" : "sdfsdfsfsddfdsf", // optional for fastpushes
    "firefox_fcm_service_account": INSERT_HERE_JSON_FROM_SERVICE_ACCOUNT
  }
}
​
post
/configureApplication for Email
https://cp.pushwoosh.com/json/1.3/configureApplication
Configures Email platform for the app.
Request
Response
Request
Body Parameters
auth
required
string
API access token from Pushwoosh Control Panel.
application
required
string
Pushwoosh application code.
device_type
required
integer
Must be 14 for Email.
email_from_email
required
string
Sender email address. Should be valid and verified. 
email_from_name
required
string
Sender name.
email_reply
optional
string
Email address to reply to. Should be valid and verified. 
Response
200: OK
{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "providers": {
      "ios": false,
      "android": false,
      "wp7": false,
      "macos": false,
      "blackberry": false,
      "wns": false,
      "adm": false,
      "safari": false,
      "email": true
    }
  }
}
For Private Offering subscriptions only.
Example
{
  "request":{
    "auth": "yxoPUlwqm…………pIyEX4H", // API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // Pushwoosh application code
    "device_type": 14, // 1 - ios, 2 - blackberry, 3 - android, 5 - windows phone, 7 - osx, 8 - windows, 9 - amazon, 10 - safari, 11 - chrome, 14 - email
    "email_from_email": "email@domain.com", // email address should be valid and verified
    "email_from_name": "SENDER_NAME",  
    "email_reply": "email@domain.com" // Email address to reply should be valid and verified
  }
}
​