Skip to main content

List your nudges

Once you have created one or more nudges, you might want to review them to ensure they align with your health messaging goals or to select which nudge to update or delete.

Endpoint Details

  • Endpoint: https://wbsapi.withings.net/v2/nudge
  • Method: POST

Run In Postman

Parameters

  • action: Use list to retrieve all created nudges.
  • Authentication parameters: signature, client_id, nonce.

Example Request for Listing Nudges

To list all the nudges you've created — the response includes a model field (17 for Body Pro 2, 47 for BPM Pro 2) for each nudge so you can tell which device each one targets:

{
    "action": "list",
    "signature": "generated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue"
}

Response from the API:

{
    "status": 0,
    "body": {
        "nudges": {
            "4": {
                "id": 4,
                "iconids": [
                    3
                ],
                "content": [
                    "Line 1",
                    "Line 2"
                ],
                "campaignids": [],
                "model": 17,
                "position": "first",
                "created": 1712008389,
                "modified": 1712008389
            },
            "5": {
                "id": 5,
                "iconids": [
                    3
                ],
                "content": [
                    "Line 1",
                    "Line 2"
                ],
                "campaignids": [],
                "model": 47,
                "position": "first",
                "created": 1712008821,
                "modified": 1712008821
            }
        }
    }
}