Named User Update API

Named User Update API

Simplify your user onboarding flow with the new named user update API.

Thanks to your feedback, we are rolling out a new named user API that lets you register named users and set tags and attributes in the same call — operations that were previously only possible in separate calls.

The Named User Update endpoint supports multiple named user operations:

  • Associate/Disassociate a named user with a channel
  • Set/Add/Remove tags on a named user
  • Set/Remove attributes on a named user
POST /api/named_users/john_doe HTTP/1.1
Authorization: Basic <application or master authorization string>
Accept: application/vnd.urbanairship+json; version=3;
Content-Type: application/json

{
   "associate": [
      {
         "email_address": "john@company.com"
      },
      {
         "channel_id": "f5346fa3-99f1-496d-be37-2895ef58f5a5",
         "device_type": "sms"
      }
   ],
   "tags": {
      "set": {
         "subscription_status": [
            "gold"
         ],
         "favorites": [
            "sports",
            "stonks"
         ]
      }
   },
   "attributes": [
      {
         "action": "set",
         "key": "name",
         "value": "John"
      }
   ]
}

Take a look at this short tutorial for an overview of the new onboarding workflow made possible with this API: