Once a user has been added to Iterable, you can update their
email address by calling the POST /api/users/updateEmail
API.
Instructions
-
Navigate to the Iterable API Explorer and input your API key in the top-left corner.
NOTE
To learn more about API keys, read API Keys.
Navigate to the
POST /api/users/updateEmail
API call.-
Specify a request body. For example:
{ "currentEmail": "oldEmail@example.com", "newEmail": "newEmail@example.com" }
Click Submit API Request.
-
Watch out for two common errors:
-
When
currentEmail
does not exist:{ "msg": "Cannot change user Some(oldEmail@iterable.com) to newEmail@iterable.com. User does not exist", "code": "BadParams", "params": null }
-
When
newEmail
already exists:{ "msg": "Cannot change user Some(oldEmail@iterable.com) to newEmail@iterable.com. New email already exists", "code": "EmailAlreadyExists", "params": null }
-
When
newEmail
is GDPR forgotten:{ "msg": "Cannot change user oldEmail@iterable.com to newEmail@iterable.com. New email is on the forgotten list", "code": "EmailAlreadyExists", "params": null }
-
Comments
0 comments
Please sign in to leave a comment.