Pushwoosh API overview
The Pushwoosh API allows developers to interact with the Pushwoosh platform.
What can you do with Pushwoosh API?
With Pushwoosh API you gain access to an extensive library of over 100 methods enabling you to:
- Send personalized push notifications
- Create, import, export and manage user segments for precise targeting
- Utilize bulk APIs to manage users/devices in batches
- Configure applications
- Track user events and add tags to users to enhance targeting and personalization
- Create and manage Pushwoosh Entities such as presets, tags, events, applications, etc.
- Start Pushwoosh Customer Journeys via API
- Retrieve comprehensive statistics on Customer Journeys and Push/Email/SMS Campaigns.
- Implement geofencing to send location-based notifications when users enter or exit specific geographic areas
- Seamlessly integrate 3rd party services with Pushwoosh
To explore the full range of available methods and discover the extensive capabilities of the Pushwoosh API, please refer to the API methods reference index.
Authentication
The Pushwoosh API uses API tokens to authenticate requests. Each Pushwoosh account has an API Access Token created by default for the Pushwoosh Demo App. You can view and manage your API token in the Pushwoosh control panel. Learn more
Rate Limits
A rate limit is the number of requests the API can receive in a given period. While most API requests in Pushwoosh are not limited, /createMessage API requests are capped at 600 per minute to ensure service quality for all users.
Requests
HTTPS is mandatory for all API requests ensuring secure data transfer.
Responses
Pushwoosh API typically returns JSON responses.
Success and error codes
Success codes
When your API request is processed successfully, you will receive a success code as part of the response.
| HTTP Status code | Status message | Description |
|---|---|---|
| 200 | OK | Pushwoosh successfully processed the request |
Please note that when you get an HTTP 200 response, it means that your request was understood and processed successfully, but it doesn’t guarantee the action’s success. So make sure to check for error or warning messages (access denied, application not found, invalid API key, etc) to determine the action’s success.
| Status code | Status message |
|---|---|
| 200 | Warnings: You have reached the subscriber limit. Push Message will be sent to 1 random device only |
| 200 | Warnings: You have exceeded the number of active devices allowed on your current subscription plan. |
| 210 | Access denied or application not found |
| 210 | Application not found |
| 210 | Application suspended |
| 210 | Account not found |
| 210 | Account has been suspended |
| 210 | Suspended account can not use device filtration |
| 210 | API token or application is not set |
| 210 | Please select at least one platform |
| 210 | Invalid API Token: Account not found |
| 210 | No application or group code given |
| 210 | API token or application or account is not set |
Error codes
In case your request isn’t correctly formatted, encounters processing issues, or experiences any other errors, Pushwoosh will send you an error code indicating the nature of the issue, helping you troubleshoot and address the problem effectively.
| HTTP Status code | Status message | Description |
|---|---|---|
| 400 | Bad request | The request can not be fulfilled due to bad syntax |
| 401 | Unauthorized | Authentication has failed or hasn’t been provided |
| 403 | Token restrictions forbid this operation. | Your access token lacks the necessary permissions to perform the requested action. To fix this, review your access token’s permissions in the Pushwoosh control panel and adjust them as needed to match the requirements for the specific operation you want to carry out. |
| 404 | Resource not found | Indicates that the requested resource, such as an app, could not be located or does not exist on the server. |
| 500 | Internal error | There was an unexpected issue or error on the server while processing the API request. |