Data structures define the format of the data being transferred to the Make platform. For example, they are widely used by the Data stores component. The following endpoints allow you to create and manage data structures.
Retrieves a data structure with a given ID
The data structure ID. Get the dataStructureId with the list data structures endpoint.
1459Successful response
Deletes a data structure with a given ID and returns the ID in the response.
The data structure ID. Get the dataStructureId with the list data structures endpoint.
1459Confirms the deletion if a data structure is included in at least one scenario. Confirmation is required because the scenario will stop working without the data structure. If the parameter is missing or it is set to false an error code is returned and the resource is not deleted.
trueSuccessful response
Retrieves a collection of all data structures for a team with a given ID. Returned data structures are sorted by name in ascending order.
The unique ID of the team whose data structures will be retrieved.
123The value that will be used to sort returned entities by.
The value of entities you want to skip before getting entities you need.
The sorting order. It accepts the ascending and descending direction specifiers.
Sets the maximum number of results per page in the API call response. For example, pg[limit]=100. The default number varies with different API endpoints.
Successful response
Creates a new data structure with data passed in the request body. In the response, it returns all details of the created data structure including its full specification.
The unique ID of the team in which the data structure will be created.
The name of the data structure. The maximum length of the name is 128 characters.
Set to true to enforce strict validation of the data put in the data structure. With the strict validation enabled, the data structure won't store data that don't fit into the structure and the storing module will return an error.
The default value of this parameter is false. With the default setting, the modules using the data structure will process data that don't conform to the data structure.
trueSuccessful response
Updates the specified data structure. Make updates only parameters you send in the request body.
Note that when you update the data structure specification with the spec parameter, you have to provide all structure fields you want to use. Make replaces the old structure specification with the new one.
The response contains all details about the updated data structure.
The data structure ID. Get the dataStructureId with the list data structures endpoint.
1459The name of the data structure. The maximum length of the name is 128 characters.
Set to true to enforce strict validation of the data put in the data structure. With the strict validation enabled, the data structure won't store data that don't fit into the structure and the storing module will return an error.
The default value of this parameter is false. With the default setting, the modules using the data structure will process data that don't conform to the data structure.
falseSuccessful response
Clones the specified data structure. Use the targetTeamId to clone the data structure to the specified team.
The response contains all details of the data structure clone with data structure full specification.
The data structure ID. Get the dataStructureId with the list data structures endpoint.
1459The name of the data structure clone. The maximum length of the name is 128 characters.
The ID of the team that should use the data structure clone. If you don't specify the targetTeamId Make clones the data structure in the original team.
Successful response