fix: always create an alias for existing profiles (#17)

Author: johnnagro

CHANGELOG.rst

@@ -14,6 +14,10 @@ Change Log
 Unreleased
 ~~~~~~~~~~
 
+[0.1.8]
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+fix: always create an alias for existing profiles
+
 [0.1.7]
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 feat: add retrieve_unsubscribed_emails method

braze/__init__.py

@@ -2,4 +2,4 @@
 Python client for interacting with Braze APIs.
 """
 
-__version__ = '0.1.7'
+__version__ = '0.1.8'

braze/client.py

@@ -222,17 +222,22 @@ def create_braze_alias(self, emails, alias_label, attributes=None):
         attributes = attributes or []
 
         for email in emails:
-            if not self.get_braze_external_id(email):
-                user_alias = {
-                    'alias_label': alias_label,
-                    'alias_name': email,
-                }
-                user_aliases.append(user_alias)
-                attribute = {
-                    'user_alias': user_alias,
-                    'email': email,
-                }
-                attributes.append(attribute)
+            user_alias = {
+                'alias_label': alias_label,
+                'alias_name': email,
+            }
+            braze_external_id = self.get_braze_external_id(email)
+            # Adding a user alias for an existing user requires an external_id to be
+            # included in the new user alias object.
+            # http://web.archive.org/web/20231005191135/https://www.braze.com/docs/api/endpoints/user_data/post_user_alias#response
+            if braze_external_id:
+                user_alias['external_id'] = braze_external_id
+            user_aliases.append(user_alias)
+            attribute = {
+                'user_alias': user_alias,
+                'email': email,
+            }
+            attributes.append(attribute)
 
         # Each request can support up to 50 aliases.
         for user_alias_chunk in self._chunks(user_aliases, USER_ALIAS_CHUNK_SIZE):

tests/braze/test_client.py

@@ -247,10 +247,23 @@ def test_create_braze_alias_user_exists(self):
         Tests that calls to to /users/alias/new and /users/track are not made
         if a Braze user already exists for the given email.
         """
+        existing_enternal_id = '1'
         responses.add(
             responses.POST,
             self.EXPORT_ID_URL,
-            json={'users': [{'external_id': '1'}], 'message': 'success'},
+            json={'users': [{'external_id': existing_enternal_id}], 'message': 'success'},
+            status=201
+        )
+        responses.add(
+            responses.POST,
+            self.NEW_ALIAS_URL,
+            json={'message': 'success'},
+            status=201
+        )
+        responses.add(
+            responses.POST,
+            self.USERS_TRACK_URL,
+            json={'message': 'success'},
             status=201
         )
 
@@ -260,8 +273,12 @@ def test_create_braze_alias_user_exists(self):
             attributes=[]
         )
 
-        assert len(responses.calls) == 1
+        assert len(responses.calls) == 3
         assert responses.calls[0].request.url == self.EXPORT_ID_URL
+        assert responses.calls[1].request.url == self.NEW_ALIAS_URL
+        alias_data = json.loads(responses.calls[1].request.body)
+        assert alias_data['user_aliases'][0]['external_id'] == existing_enternal_id
+        assert responses.calls[2].request.url == self.USERS_TRACK_URL
 
     @responses.activate
     def test_create_braze_alias_batching(self):