Applications API

API methods to manage apps

createApplication

/createApplication

POST https://api.pushwoosh.com/json/1.3/createApplication

Creates a new application on the account.

Request Body

Name	Type	Description
authorize_all_tokens	boolean	Allows all API tokens to communicate with this app.
auth*	string	API access token from Pushwoosh Control Panel.
icon	string	Base64-encoded binary content of png file.
sdk_ios	string	iOS SDK type. Possible values: "pw" or "corona". For Corona, push payload is different.
sdk_android	string	Android SDK type. Possible values: "pw", "corona", "phonegap". AppPresser users select "phonegap".
title*	string	Title for the new app in Pushwoosh.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": "1DC69-73EDB"
  }
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
    "icon": "iVBORw0KGgoAAAANSUhEUgAAAH0AAACVCAIAAAD6...", // optional, Base-64 encoded binary content of png file 
    "authorize_all_tokens" : true, // or 'false', optional. If true, allows all api tokens to communicate with this app
    "sdk_ios": "pw", // optional. Possible values are “pw” or “corona”
    "sdk_android": "pw", // optional. Possible values are “pw”, “corona”, or “phonegap”
    "title": "APP_TITLE" // required. Title for the new app in Pushwoosh
  }
}

updateApplication

/updateApplication

POST https://api.pushwoosh.com/json/1.3/updateApplication

Updates the application settings.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.
icon	string	Base64-encoded binary content of png file.
sdk_ios	string	iOS SDK type. Possible values: "pw" or "corona". For Corona, push payload is different.
sdk_android	string	Android SDK type. Possible values: "pw", "corona", "phonegap". AppPresser users select "phonegap".
title	string	New title for the app in Pushwoosh.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX", // required, application code of the app you want to update
    "icon": "iVBORw0KGgoAAAANSUhEUgAAAH0AAACVCAIAAAD6...", // optional. Base-64 encoded binary content of png file 
    "sdk_ios": "pw", // optional. Possible values are “pw” or “corona”
    "sdk_android": "pw", // optional. Possible values are “pw”, “corona”, or “phonegap”
    "title": "APP_TITLE" // optional. New title for the app in Pushwoosh
  }
}

deleteApplication

/deleteApplication

POST https://api.pushwoosh.com/json/1.3/deleteApplication

Deletes the app from the account.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": null
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

Example

{
  "request": {
    "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
    "application": "XXXXX-XXXXX" // required, Pushwoosh application code
  }
}

getApplication

/getApplication

POST https://api.pushwoosh.com/json/1.3/getApplication

Gets details about the app.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.

200

{
  "status_code": 200,
  "status_message": "OK",
  "response": {
    "application": {
      "adm_cid": "",
      "adm_secret": "",
      "android_api_type": "x31",
      "android_gcm_api_key": "x7836363631366236353566366236353739",
      "android_sdk": "x7077",
      "icon_url": null,
      "ios_apple_appid": "x78343535613336333933363538333633373533356132653633366636643265373037353733363837373666366637333638326537343635373337343631373037303061353037353733363837373666366637333638323035343635373337343230343137303730",
      "ios_apple_team": "x7834313732363536633663366632303464366636323639366336353230346334633433",
      "ios_apple_user": "x7836313730373036633635343036313732363536633663366632643664366636323639366336353265363336663664",
      "ios_gateway": "x783330",
      "ios_key_management_type": "x783631373537343666",
      "ios_key_password": "x7836353336363236353335333736353333",
      "ios_sdk": "x7077",
      "title": "0 Application For test",
      "wp7_state": "x783635366536313632366336353634",
      "wp7_type": "x78373536653631373537343638363536653734363936333631373436353634",
      "providers": {
        "ios": true,
        "android": false,
        "wp7": false,
        "macos": true,
        "blackberry": false,
        "wns": false,
        "adm": false,
        "safari": false
      },
      "languages": {
        "en": "34",
        "zh": "12",
        "sv": "7",
        "de": "6",
        "pt": "6"
      }
    }
  }
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

  {
      "request": {
        "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
        "application": "XXXXX-XXXXX" // required, Pushwoosh application code
      }
  }

getApplications

/getApplications

POST https://api.pushwoosh.com/json/1.3/getApplications

Gets the list of applications on the account. Can return result with pagination.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
page	integer	The page number for pagination.

200

{
  "status_code":200,
  "status_message":"OK",
  "response": {
    "page" : 1,  // Current page
    "total": 2,  // Total amount of pages
    "applications":
    {
      "APPLICATION_CODE":"MyApp1",
      "APPLICATION_CODE":"MyApp2"
    }
  }
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

   {
      "request": {
        "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
        "page": 2 // optional, the page number for pagination
      }
    }

getApplicationFile

/getApplicationFile

POST https://api.pushwoosh.com/json/1.3/getApplicationFile

Gets the configuration files related to the app.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.
file*	string	Identifier of the file to retrieve. See values below.

200

{
    "status_code": 200,
    "status_message": "OK",
    "response": null
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

Example

  {
      "request": {
        "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
        "application": "XXXXX-XXXXX", // required, Pushwoosh application code
        "file": "ios_auto_privatekey" // required, identifier of the file to retrieve. See values below
      }
  }

Possible values for the "file" parameter: "ios_auto_privatekey" | "ios_manual_privatekey" | "ios_auto_certificate" | "ios_manual_certificate" | "ios_push_certificate" | "ios_provisioning_profile" | "macos_manual_privatekey" | "macos_manual_certificate" | "macos_push_certificate" | "safari_manual_privatekey" | "safari_push_certificate" | "safari_push_package", | "wp7_cert", "wp7_key", "wp7_ca"

Response example:

-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----

setApplicationPlatformStatus

/setApplicationPlatformStatus

POST https://api.pushwoosh.com/json/1.3/setApplicationPlatformStatus

Changes the plaform's status of the app.

Request Body

Name	Type	Description
auth*	string	API access token from Pushwoosh Control Panel.
application*	string	Pushwoosh application code.
platform*	integer	The platform type. See platform types list below.
status*	string	"enable" or "disable"

200

{
    "status_code": 200,
    "status_message": "OK",
    "response": {
        "message": "iOS pushes are disabled",
        "available_platforms": {
            "iOS": false,
            "BlackBerry": false,
            "Android": true,
            "Windows Phone": false,
            "OS X": false,
            "Windows": false,
            "Amazon": false,
            "Safari": false,
            "Chrome": true,
            "Firefox": false,
            "Internet Explorer 11": false
        }
    }
}

For Custom Plan subscriptions only. For more details, please contact our Sales team.

Example

{
    "request": {
    "application": "XXXXX-XXXXX", // required, Pushwoosh application code
    "auth": "yxoPUlwqm…………pIyEX4H", // required, API access token from Pushwoosh Control Panel
    "platform": 1, // required. 1 — iOS; 3 — Android; 7 — OS X; 8 — Windows 8; 9 — Amazon; 10 — Safari; 11 — Chrome; 12 — Firefox
    "status": "disable" // or "enable", required
    }
}