User.com REST API Docs

# Get webpush campaigns

You can return a list of all webpush campaigns.

GET /webpush-campaign/

  • CURL
  • JavaScript
  • PHP
  • Python 
curl -X GET -H "Authorization: Token <your_64_char_api_key>"
-H "Accept: */*; version=2"
"https://<your_app_subdomain>.user.com/api/public/webpush-campaign/"

# Response

    
    {
       "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
    "description": "Description of the web push campaign.",
    "type": 2,
    "eta": null,
    "name": "Web Push Campaign 1",
    "status": 2,
    "messages": [
        {
            "id": 1,
            "name": "Web push title",
            "message_id": 1,
            "message_title": "Web push title",
            "message_body": "Message body",
            "message_badge": null,
            "message_icon": null,
            "message_url": "https://\< path to your website >",
            "message_require_interaction": true,
            "message_doughnut_title": "",
            "message_doughnut_url": "",
            "message_actions": false,
            "message_coffee_title": "",
            "message_coffee_url": ""
        }
    ],
    "recipients": null,
    "recipients_count": 0,
    "created_at": "2021-03-25T16:01:09.687017Z",
    "updated_at": "2021-03-25T16:01:15.161743Z",
    "category": null,
    "ttl": 259200,
    "user_activity_schedule": false,
    "advance_filtering": null,
    "multiple_domains_warning": false
        },
        {
            "id": 2,
            "description": "",
            "type": 2,
            "eta": null,
            "name": "Web Push Campaign 2",
            "status": 2,
            "messages": [
                {
                    "id": 2,
                    "name": "Web push title 2",
                    "message_id": 7,
                    "message_title": "Web push title 2",
                    "message_body": "Message body 2",
                    "message_badge": null,
                    "message_icon": null,
                    "message_url": "https://\< path to your website >",
                    "message_require_interaction": false,
                    "message_doughnut_title": "",
                    "message_doughnut_url": "",
                    "message_actions": false,
                    "message_coffee_title": "",
                    "message_coffee_url": ""
                }
            ],
            "recipients": null,
            "recipients_count": 0,
            "created_at": "2021-03-29T07:44:33.077373Z",
            "updated_at": "2021-03-29T07:44:41.221321Z",
            "category": null,
            "ttl": 259200,
            "user_activity_schedule": false,
            "advance_filtering": null,
            "multiple_domains_warning": false
        }]
    }

← Get webpush campaign →