Mission Control API: Adding an address
Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.
In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.
Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with(and who we are).
For how to do this, please refer to our article on "Authentication and Tokens" after updating your credentials you can follow on from here.
In this article you will learn how to:
- Get your Address
- Create an Address
- Delete a Address
- Get an Address
- Update an Address
Get your Address:
This endpoint GETs and returns addresses associated with your account. There are 3 parameters, simply fill these in with the amount of pages you would like returned, the amount of result per page & whether or not to include addresses not found in the address book. Once you've done that, hit "Try It Out".
If you are successful, you will receive a response with your address details similar to the one below:
Congratulations! You got your Addresses! Take note of your address id, you'll need it for the rest of the address endpoints.
Create an Address:
We can use the create an address endpoint to add a new address to our account. Below is the example of the JSON body. The fields first_name, last_name, phone_number, street_address, locality and country_code are mandatory. Fill out your message body with your address details in the Parameters box. Once your ready hit "TRY IT OUT", you should get a response similar to the one below:
Congratulations you have just added an address to your Telnyx account!
Delete an Address:
We can use the delete an address endpoint to delete an address from out Telnyx account. In order to delete the address, we will need to pass the address ID as a JSON argument. If you do not have your Address ID, you can acquire it by using the "Get your address" endpoint above. Once you have you ID, enter it into the "id" box and click "TRY IT NOW". You will get a response similar to the one below letting you know if you request was successful or not.
Get an Address:
We use the get an address endpoint to find out the details of an address given we have the address ID. Simply enter in the address ID into "id" parameter box and click "TRY IT OUT". The address information will be given to you in a response similar to the below.
Update an Address:
The update an address endpoint allows you to change the details of an existing address on your account. Firstly enter the "id" of the address you want ot update in the "id" parameter box. Next prepare the JSON body with the updated address information. When you are ready, click "TRY IT OUT". If you are successful you will receive a JSON response with the updated address similar to the one below:
Congratulations! You are now able to manage your Addresses via the Mission Control API !
Can't find what you're looking for? Click the chat bubble at your lower right-hand corner and start a chat!