Update or delete a nudge

After creating a nudge, you may find the need to update its content or icons based on user feedback or new health messaging strategies. This section guides you through the process of updating an existing nudge.

Endpoint Details

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

Parameters

• action: Use update to modify an existing nudge.
• nudgeid: The ID of the nudge you wish to update (returned in nudge-v2.create or nudge-v2.list).
• Other parameters as in the create action, depending on what you wish to update (iconids, content, etc.).

Updating Nudge Content Example

Let's try to update the nudge that we previously created to be more specific.

{
    "action": "update",
    "signature": "genarated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue",
    "nudgeid": 103,
    "content": ["Stay Hydrated!", Drink 2L of water daily."]
}

We get the following response from the API:

{
    "status": 0,
    "body": {
        "nudgeid": 103
    }
}

Deleting a Nudge

There might be scenarios where a nudge is no longer relevant or needs to be removed from your campaign. Here's how to delete a nudge.

Endpoint Details

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

Parameters

• action: Use delete to remove a nudge.
• nudgeid: The ID of the nudge you wish to delete.

Deleting a Nudge Example

To delete the hydration reminder nudge:

{
    "action": "delete",
    "signature": "genarated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue",
    "nudgeid": 103
}

This request will permanently remove the specified nudge.

We get the following response from the API:

{
    "status": 0,
    "body": {}
}