Can't create more than 1 email forward

TimeHorse

I have been having problems using the API to set email addresses to my account. I was given an ID to use to set them, but it seems IDs are catch-22: if the email address already exists, you can use create to replace it but you can't add new email addresses using the /api/v1/address/create/ api. In fact, the documentation for that API implies you don't need to provide an ID but when you execute it and your JSON doesn't have an ID, then the REST response is that you need an ID. But to create a new email you need a new, unique ID, and you don't know what that will be so, catch-22. I use the API to send hundreds of email addresses to my domain but it repeatedly fails for 90% of them and when it does succeed, it just replaces the one and only email forward I have. I still only have one email forward. What's the point of an API if I have to manually add the addresses through the UI anyway? Do I need to crack out the selenium??

sean

TimeHorse you don't need the address ID of an email address when creating an email address and in fact it is impossible because the ID of the address doesn't exist until the address is created.

To add a forward to an existing address you must first get the existing forwards by calling address/read. If you don't know the ID of the address you're updating, then instead call address/list to get all of your addresses and filter the results to get the ID of the address you want to update. Then, add your second forward to the list of existing forwards and pass it back to address/update along with the ID.

For example, here is a sample result from address/read for an address with ID "XXXXX-XXX-XXX-XXXXX":

{
  "id": "XXXXX-XXX-XXX-XXXXX",
  "state": "READY",
  "ready": true,
  "source": "user@example.com",
  "destinations": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "forwards": [
    "user@example.com"
  ]
}

To add a forward to that address you would pass the following to address/update:

{
  "id": "XXXXX-XXX-XXX-XXXXX",
  "forwards": [
    "user@example.com", "otheruser@otherexample.com"
  ]
}

TimeHorse

You have no id when creating a new email and you get back: [{"id":["This field is required."]}]

If I could programmatically create new emails, that’s all I’m asking! I don’t want change what’s there as there’s one there now, just one! I need to create hundreds!!! Plus, your documentation is buggy because it says you don’t need an id to create but clearly you do so catch-22!

sean

TimeHorse You don't need an ID when creating a new email address. I suspect you're calling the wrong API method.

Here's an example of how to create a forwarding email address, then look up its ID, then add a second forwarding address to it:

import requests

# your API token
TOKEN = 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXX'

headers = { 'Content-Type': 'application/json', 'Authorization': f'Token {TOKEN}'  }

# create a forwarding address
email = 'me@domain.com'
forwards = ['me@otherdomain.com',]
data = [{'source':email, 'forwards':forwards}]

response = requests.post('https://my.opalstack.com/api/v1/address/create/', json=data, headers=headers)

# if you need to modify the address immediately the new address info including ID is now in response.json()[0]:
# [{'id': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX',
#   'state': 'PENDING_CREATE',
#   'ready': False,
#   'source': 'me@domain.com',
#   'destinations': [],
#   'forwards': ['me@otherdomain.com']}]


# if you need to modify the address later, first look up the address from address/list:
response = requests.get('https://my.opalstack.com/api/v1/address/list/', json=data, headers=headers)
address = [i for i in response.json() if v['source'] == email][0]

# the email address info is now stored in the var 'address'
# {'id': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX',
#  'state': 'READY',
#  'ready': True,
#  'source': 'me@domain.com',
#  'destinations': [],
#  'forwards': ['me@otherdomain.com']}


# now add a new forward to the address using the info you looked up:
other_forward = 'metoo@anotherdomain.com'
address['forwards'].append(other_forward)
data = [{'id':address['id'],'forwards':address['forwards']}]
response = requests.post('https://my.opalstack.com/api/v1/address/update/', json=[address,], headers=headers)

# the updated address info is now in response.json()[0]:
# [{'id': 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXX',
#   'state': 'PENDING_UPDATE',
#   'ready': False,
#   'source': 'me@domain.com',
#   'destinations': [],
#   'forwards': ['me@otherdomain.com', 'metoo@anotherdomain.com']}]

TimeHorse

Got it! Thanks! I had a typo in the REST URL

sean

TimeHorse we have a Python wrapper for the API that might make things easier for you, ie you won't have to deal with method endpoints: https://pypi.org/project/opalstack/

TimeHorse

sean I did download the wrapper package but didn't have time to dig into what it offers. I do like the simple REST API though as it's pretty easy to understand. But yes, I like those wrapper. Just wish they were better documented.