Skip to main content

Updating a Nudge Campaign

This section covers the processes for updating existing campaigns and removing them when they're no longer needed.

Endpoint Details

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

Run In Postman

Required Parameters

  • action: Must take the value update.
  • signature, client_id, nonce: Authentication parameters, similar to campaign creation.
  • nudgecampaignid: The ID of the campaign you wish to update.
  • nudgeid, startdate, enddate, max_display_count: Parameters you wish to update.
  • Authentication parameters: signature, client_id, nonce.

Example Request for Updating a Campaign

To extend the end date of our hydration campaign:

{
"action": "update",
"signature": "generated_signature",
"client_id": "YourClientID",
"nonce": "UniqueNonceValue",
"nudgecampaignid": 3,
"enddate": "1712016369"
}

This updates the campaign to continue until the end of 2025, ensuring prolonged engagement.

Deleting a Nudge Campaign

Removing a campaign might be necessary if it's no longer relevant or to clear the way for new health initiatives.

Endpoint Details

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

Run In Postman

Required Parameters

  • action: Must take the value delete.
  • nudgecampaignid: The ID of the campaign you wish to remove.
  • Authentication parameters: signature, client_id, nonce.

Example Request for Deleting a Campaign

To delete our hydration campaign:

{
"action": "delete",
"signature": "generated_signature",
"client_id": "YourClientID",
"nonce": "UniqueNonceValue",
"nudgecampaignid": 3
}

This request will permanently remove the specified hydration campaign.