API Overview

All endpoints hit using GET verb take parameters in the query string. This test endpoint enables you to test that a simple call using parameters in the query string functions normally. It has no impact on the application.

Sometimes, URLs can take attributes, that should be replaced by a resource identifier.

All endpoints hit using POST, PUT and DELETE take parameters in the request payload. This test endpoint enables you to test that a simple call using a JSON body functions normally. It has no impact on the application.

This test endpoint enables you to test that uploading a file to WeTransform functions normally. It has no impact on the application.

All endpoints hit using GET verb take parameters in the query string.

Sometimes, URLs can take attributes, that should be replaced by a resource identifier.

All endpoints hit using POST, PUT and DELETE take parameters in the request payload.

Use this endpoint to list all source configurations.

This endpoint will list all transformations, paginated. A transformation has a source file, a template name, and has been initiated, but has not necessarily finished.

This endpoint will list all deleted (trashed) transformations, paginated.

This endpoint will give details about a particular transformation, such as its import date, source file name, download_url and more.

This endpoint will delete a transformation.

This endpoint will restore a previously deleted transformation.

This endpoint can be used to run an existing transformation. It requires that

1. a source file was already uploaded, 2) the source file is dynamic
2. a template has been chosen. This will refresh the source file, and run the transformation with the new source file.

This endpoint will return the status of the transformation provided the source file is dynamic.

This endoint allows to get portions of transformed file before it is actually submitted. A use case, if used with the update data from a transformation endpoint, is to allow to make changes to the file while a transformation is still pending and the file has not been submitted yet.

This endpoint allows to post changes to a transformation, such as updating content on specific attributes, before the file is actually fully transformed and submitted.

Get a list of all templates and filter them using metadata in the query string. You can define metadata in the template's General setting menu. For example, this can be useful to categorize your templates.

Get a list of all customers having access to a particular template, using the template UUID.

Get the list of all your customers, including details such as WeTransform UUID, external_id, name, email, templates they have access to and more.

Get details for a customer, such as its email, and list of available templates, from the WeTransform customer UUID.

Give specific templates access to a customer, using its WeTransform UUID, or update other details.

Create a customer specifying its external_id, and allowing specific templates. Creating an already existing customer will return a 409 error.

Delete a customer using its WeTransform UUID. Deleting a customer will delete the corresponding transformations done by this customer.