API endpoints
Once you’ve completed the set-up from this article you can test out the endpoints of the API:
Checking Taxi Syntax
Creating a New Email Design System
Updating an existing Email Design System
Taxi Syntax Checks
This endpoint enables you to check the Taxi Syntax in your EDS without having to upload the file to Taxi directly.
There is only one parameter for this endpoint: HTML. It is required and it needs to be a .html file.
When you use this endpoint, any errors you do have will be returned in JSON format.
Here is an example of the JSON response:
Possible Errors
Error status code | Reason |
400 | If you don’t include the html parameter |
401 | If the api credentials are incorrect |
429 | If the number of times you try and complete the checks exceed the rate limit (10 times per minute) |
500 | Something went wrong on our side, try again later |
Creating an Email Design System
This endpoint enables you to create an EDS without having to log into Taxi and upload a file or paste the HTML.
There are two required parameters
Source The HTML file you want to upload to Taxi
Name The name you want to give this Email Design System
There are three optional parameters.
Description The description you want to give the Email Design System in Taxi. If you don’t use this parameter the EDS will have no description.
Import_images When uploading an EDS you can choose where you want to host the images, either on the Taxi cdn or for them to stay where they are already hosted.
This is a boolean parameter, so the value can be true or false.If it is set to true images in the EDS will be hosted with Taxi. If it is set to false the images will stay where they are already hosted.
The API currently doesn’t enable you to use zip files for the source parameter so if you have images in a zip file along with the HTML, this will need to be configured in Taxi.
If you don’t use this parameter the default is false, so where the images are hosted won’t be changed.
Without_review This is another boolean parameter.
If it is set to true then the Email Design System upload will be completed without having to log into Taxi. If it is set to false you will need to log in to Taxi and complete the process. You will see a ‘not ready’ message on the EDS when visiting the Email Design System page in Taxi. The response also includes a URL to the EDS in Taxi so you can easily find the EDS to finish updating in Taxi if you need. If you don’t use this parameter the default will be false so you will need to finalise the upload in Taxi.
Here is an example response:
Possible Errors
Error | Reason |
400 | - If you don’t include the required parameters - If the user does not have permission to create an EDS - If the you have reached the limit of EDS allowed in your account |
401 | If the api credentials are incorrect |
403 | If you do not have permission to create an Email Design System |
409 | If the name of the EDS already exists for that organisation |
422 | If the HTML file has errors which stops it being uploaded |
429 | If the number of times you try and complete the checks exceed the rate limit (10 times per minute) |
500 | Something went wrong on our side, try again later |
Updating an Email Design System
This endpoint enables you to update an existing Email Design System in Taxi without having to log in.
There are two required parameters.
Id The id of the existing EDS. This can be found on the EDS page in your Taxi account.
Source
The HTML file you want to use to update the EDS in Taxi
There are four optional parameters
Name Use this if you want to override the name of the EDS you are updating. If you don’t use this, the current name will remain unchanged.
Description Use this if you want to override the description of the EDS you are updating. If you don’t use this, the current description will remain unchanged.
Import_images When uploading an EDS you can choose where you want to host the images, either on the Taxi CDN or for them to stay where they are already hosted.
This is a boolean parameter, so the value can be true or false. If it is set to true images in the EDS will be hosted with Taxi. If it is set to false the images will stay where they are already hosted.
The API currently doesn’t enable you to use zip files for the source parameter so if you have images in a zip file along with the HTML, this will need to be configured in Taxi.
If you don’t use this parameter the default will be whatever was selected when the EDS was created or last updated.
Without_review This is another boolean parameter.
If it is set to true then the Email Design System upload will be completed without having to log into Taxi.
If it is set to false you will need to log in to Taxi and complete the process. You will see a ‘not ready’ message on the EDS when viewing it in Taxi.
The response also includes a URL to the EDS in Taxi so you can easily find the EDS to finish updating in Taxi if you need.
If you don’t use this parameter the default will be false so you will need to finalise the upload in Taxi.
Here is an example response:
Possible Errors
Error | Reason |
400 | - If you don’t include the required parameters - If the you have reached the limit of EDS allowed in your account |
401 | If the api credentials are incorrect |
403 | If the user does not have permission to create an Email Design System |
404 | If the EDS id provided does not exist |
409 | If the name of the EDS already exists for that organisation |
422 | If the HTML file has errors which stops it being uploaded |
429 | If the number of times you try and complete the checks exceed the rate limit (10 times per minute) |
500 | Something went wrong on our side, try again later |
Last updated