Skip to main content
PUT
/
api
/
external
/
eligible-users
Update Eligible Users
curl --request PUT \
  --url https://backend.nebuly.com/api/external/eligible-users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "users": [
    {
      "end_user": "<string>",
      "tags": {},
      "active_from": "<string>",
      "active_to": "<string>"
    }
  ]
}
'
{ "users": 
  [
    {
      "end_user": "alice@example.com",
      "tags": { 
        "Product Tier": "Premium", 
        "Country": "US" 
      },
      "active_from": "2026-01-01",
    },
    {
      "end_user": "bob@example.com",
      "tags": { 
        "Product Tier": "Standard", 
        "Country": "CA" 
      },
      "active_from": "2025-06-23",
      "active_to": "2026-01-12"
    }
  ] 
}
This endpoint allows you to update existing eligible users. A match is made using the end_user field, and any metadata (such as tags, active_from, or active_to) is replaced accordingly. You need an API key to authenticate. See here for more information about the API keys.
users
PlatformUser[]
required
A list of user objects to update.
users
EligibleUser[]
The list of users that were successfully updated.
{ "users": 
  [
    {
      "end_user": "alice@example.com",
      "tags": { 
        "Product Tier": "Premium", 
        "Country": "US" 
      },
      "active_from": "2026-01-01",
    },
    {
      "end_user": "bob@example.com",
      "tags": { 
        "Product Tier": "Standard", 
        "Country": "CA" 
      },
      "active_from": "2025-06-23",
      "active_to": "2026-01-12"
    }
  ] 
}