Data structures

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.

List data structures

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures

Retrieves a collection of all data structures for a team with a given ID. Returned data structures are sorted by name in ascending order.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Query parameters

teamIdintegerRequired

The unique ID of the team whose data structures will be retrieved.

Example: 123

pg[sortBy]string · enumOptional

The value that will be used to sort returned entities by.

Possible values:

pg[offset]integerOptional

The value of entities you want to skip before getting entities you need.

pg[sortDir]string · enumOptional

The sorting order. It accepts the ascending and descending direction specifiers.

Possible values:

pg[limit]integerOptional

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.

Responses

200

Successful response

application/json

get

/data-structures

HTTPcURLJavaScriptPython

GET /api/v2/data-structures?teamId=1 HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "dataStructures": [
    {
      "id": 9,
      "name": "Data structure 1",
      "teamId": 1
    },
    {
      "id": 1,
      "name": "Data structure 2",
      "teamId": 1
    }
  ],
  "pg": {
    "sortBy": "name",
    "sortDir": "asc",
    "limit": 10000,
    "offset": 0
  }
}

Create data structure

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Body

application/json

teamIdintegerRequired

The unique ID of the team in which the data structure will be created.

namestring · min: 1 · max: 128Required

The name of the data structure. The maximum length of the name is 128 characters.

strictbooleanRequired

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.

Example: true

Responses

200

Successful response

application/json

post

/data-structures

HTTPcURLJavaScriptPython

POST /api/v2/data-structures HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 240

{
  "teamId": 1,
  "name": "Data structure 1",
  "strict": true,
  "spec": [
    {
      "type": "text",
      "name": "txt",
      "label": "Text field",
      "default": "default string",
      "required": true
    },
    {
      "type": "number",
      "name": "num",
      "label": "Number field",
      "default": "1,",
      "required": false
    }
  ]
}

200

Successful response

{
  "dataStructure": {
    "id": 9,
    "name": "Data structure 1",
    "teamId": 1,
    "spec": [
      {
        "type": "text",
        "name": "txt",
        "label": "Text field",
        "default": "default string",
        "required": true
      },
      {
        "type": "number",
        "name": "num",
        "label": "Number field",
        "default": "1,",
        "required": false
      }
    ],
    "strict": true
  }
}

Get data structure

get

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures/{dataStructureId}

Retrieves a data structure with a given ID

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStructureIdintegerRequired

The data structure ID. Get the dataStructureId with the list data structures endpoint.

Example: 1459

Query parameters

Responses

200

Successful response

application/json

get

/data-structures/{dataStructureId}

HTTPcURLJavaScriptPython

GET /api/v2/data-structures/{dataStructureId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "dataStructure": {
    "id": 9,
    "name": "Data structure 1",
    "teamId": 1,
    "spec": [
      {
        "type": "text",
        "name": "txt",
        "label": "Text field",
        "default": "default string",
        "required": true
      },
      {
        "type": "number",
        "name": "num",
        "label": "Number field",
        "default": "2,",
        "required": false
      }
    ],
    "strict": true
  }
}

Delete data structure

delete

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures/{dataStructureId}

Deletes a data structure with a given ID and returns the ID in the response.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStructureIdintegerRequired

The data structure ID. Get the dataStructureId with the list data structures endpoint.

Example: 1459

Query parameters

confirmedbooleanOptional

Confirms 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.

Example: true

Responses

200

Successful response

application/json

delete

/data-structures/{dataStructureId}

HTTPcURLJavaScriptPython

DELETE /api/v2/data-structures/{dataStructureId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "dataStructure": 1
}

Update data structure

patch

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures/{dataStructureId}

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStructureIdintegerRequired

The data structure ID. Get the dataStructureId with the list data structures endpoint.

Example: 1459

Body

application/json

namestring · min: 1 · max: 128Optional

The name of the data structure. The maximum length of the name is 128 characters.

strictbooleanOptional

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.

Example: false

Responses

200

Successful response

application/json

patch

/data-structures/{dataStructureId}

HTTPcURLJavaScriptPython

PATCH /api/v2/data-structures/{dataStructureId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "name": "Data structure 1",
  "spec": [
    {
      "type": "text",
      "name": "txt",
      "label": "Text field",
      "default": "default string",
      "required": true
    },
    {
      "type": "number",
      "name": "num",
      "label": "Number field",
      "default": "2,",
      "required": false
    }
  ]
}

200

Successful response

{
  "dataStructure": {
    "id": 9,
    "name": "Data structure 1",
    "teamId": 1,
    "spec": [
      {
        "type": "text",
        "name": "txt",
        "label": "Text field",
        "default": "default string",
        "required": true
      },
      {
        "type": "number",
        "name": "num",
        "label": "Number field",
        "default": "2,",
        "required": false
      }
    ],
    "strict": true
  }
}

Clone data structure

post

https://eu1.make.com/api/v2https://eu2.make.com/api/v2https://us1.make.com/api/v2https://us2.make.com/api/v2https://eu1.make.celonis.com/api/v2https://us1.make.celonis.com/api/v2

/data-structures/{dataStructureId}/clone

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

token

AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters

dataStructureIdintegerRequired

The data structure ID. Get the dataStructureId with the list data structures endpoint.

Example: 1459

Body

application/json

namestring · min: 1 · max: 128Required

The name of the data structure clone. The maximum length of the name is 128 characters.

targetTeamIdintegerOptional

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.

Responses

200

Successful response

application/json

post

/data-structures/{dataStructureId}/clone

HTTPcURLJavaScriptPython

POST /api/v2/data-structures/{dataStructureId}/clone HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "name": "Cloned data structure",
  "targetTeamId": 22
}

200

Successful response

{
  "dataStructure": {
    "id": 2547,
    "name": "Cloned data structure",
    "teamId": 22,
    "spec": [
      {
        "type": "text",
        "name": "txt",
        "label": "Text field",
        "default": "default string",
        "required": true
      },
      {
        "type": "number",
        "name": "num",
        "label": "Number field",
        "default": "1,",
        "required": false
      }
    ],
    "strict": true
  }
}