Skip to main content

Adding and Removing Users to a Campaign

An integral part of nudge campaign management is dynamically adjusting which users are part of each campaign. Whether you're expanding your target audience or refining it.

Adding Users to a Campaign

Endpoint Details

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

Parameters

  • action: Use addusers to add users to a campaign.
  • nudgecampaignid: The ID of the campaign to which users will be added.
  • userids: An array of user IDs that you wish to add to the campaign.
  • Authentication parameters: signature, client_id, nonce.

Run In Postman

Example Request for Adding Users

To add new users to our hydration campaign:

{
    "action": "addusers",
    "signature": "generated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue",
    "nudgecampaignid": 3,
    "userids": [1223124,2512251]
}

Removing Users to a Campaign

Endpoint Details

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

Parameters

  • action: Use removeusers to remove users from a campaign.
  • nudgecampaignid: The ID of the campaign from which users will be removed.
  • userids: An array of user IDs to remove from the campaign.
  • Authentication parameters: signature, client_id, nonce.

Run In Postman

Example Request for Removing Users

To refine the target audience of our hydration campaign:

{
    "action": "removeusers",
    "signature": "generated_signature",
    "client_id": "YourClientID",
    "nonce": "UniqueNonceValue",
    "nudgecampaignid": 3,
    "userids": [1223124,2512251]
}

This removes specified users from the campaign, allowing for more targeted health messaging.

Considerations for Adding/Removing Users

  • Dynamic Engagement: Regularly assess user engagement and campaign goals to adjust participation as needed.
  • User Feedback: Be responsive to user preferences, adding or removing them based on feedback or opt-in/opt-out requests.