Event::Send

Alias or Device GUID

Please note that if you set the customer’s alias, this API endpoint requires either the Pulsate Device GUID or the User’s Alias, not both. For more information on deduping and setting an alias for a user, please see our guides on Android and iOS.

POST /api/mobile/v4/users/update

Note

Authentication required.

Body Parameters

Name	Type	Required	Description
alias	string	Yes	The Alias (your Customer or User Id)
guid	string	Yes	A unique identifier for the current device of the User
in_app_events	array_object	No

Responses

200

{
    "in_app_notification": {
        "created_at": 1660908691,
        "guid": "abcd1234",
        "position": "top",
        "size": "large",
        "type": "personal",
        "campaign_guid": "def5678",
        "allow_reply": null,
        "front": [
            {
                "type": "admin_header_with_message",
                "position": -1,
                "attrs": [
                    {
                        "admin": {
                            "job_title": "CEO",
                            "name": "Sarah Martin",
                            "s_id": "wef09uerno34nng34r",
                            "avatar_url": "https://control.pulsatehq.com/assets/lib/layout/default-user-avatar.svg"
                        },
                        "message": "Get Started with Pulsate"
                    }
                ]
            },
            {
                "type": "call_to_action",
                "position": 3,
                "attrs": [
                    {
                        "destination_type": "openfeed",
                        "destination": "",
                        "in_app_events": null,
                        "label": "View Feed",
                        "shown_btn": true,
                        "show_in_app": false,
                        "order_number": 1
                    },
                    {
                        "destination_type": "deeplink",
                        "destination": "/some/deeplink",
                        "in_app_events": null,
                        "label": "Open Deeplink",
                        "shown_btn": true,
                        "show_in_app": false,
                        "order_number": 2
                    }
                ]
            },
            {
                "type": "headline",
                "position": 1,
                "attrs": [
                    {
                        "text": "We're excited to have you partner with us"
                    }
                ]
            },
            {
                "type": "image",
                "position": 0,
                "attrs": [
                    {
                        "name": "android_matrix.jpg",
                        "image_url": "https://pulsate-campaign-attachments-production.s3.eu-west-1.amazonaws.com/2022-08-19/5fa13b64636f6e4be81b0000/1660908328_android_matrix.jpg",
                        "width": 1920,
                        "height": 1080
                    }
                ]
            },
            {
                "type": "text",
                "position": 2,
                "attrs": [
                    {
                        "text": "With Pulsate you can deliver relevant and Customised campaigns and Journeys to your Users."
                    }
                ]
            }
        ]
    }
}