Changing a user account email

  1. Authenticate to the cloud platform via the Python shell.

    The following variables should be available now:

    >>> base_url  # the base URL of the API
    >>> auth  # the 'Authorization' header value with the access token
    {'Authorization': 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImtpZCI6ImMwMD...'}
    >>> tenant_id  # the UUID of the tenant to which the token provides access
  2. Assign the user_id variable the UUID of a user account created via the API or a user account found via search:

    >>> user_id = created_user_id
    >>> user_id
  3. Fetch the revision number of the user account as described in the chapters above. The following variable should be available now:

    >>> version
  4. Define a variable named user_data, and then assign the user account email to update to this variable:

    >>> user_data = {
    ...      "contact": {
    ...          "email": ""
    ...      },
    ...      "version": version
    ... }


    Value type




    contact object


    The contact information of an account.




    Revision number.

  5. Convert the user_data object to a JSON text:

    >>> user_data = json.dumps(user_data, indent=4)
  6. Send a PUT request with the JSON text to the /users/{user_id} endpoint:

    >>> response = requests.put(
    ...     f'{base_url}/users/{user_id}',
    ...     headers={'Content-Type': 'application/json', **auth},
    ...     data=user_data,
    ... )
  7. Check the status code of the response:

    >>> response.status_code

    Status code 200 means that the email has been changed if the user account was not activated, or that an email confirmation link has been sent to the old email address of the user account if the user account was activated.

    A different status code means that an error has occurred. For the details, refer to “Status and error codes”.


  • Email will be changed only when a user has opened the email confirmation link.

  • The revision number will be incremented only if the email has been changed for a non-activated user account.