Custom properties > Structure items

The following endpoints allow you to manage items in a custom property structure.

To use custom properties, you have to:

1. Create a custom properties structure.

2. Create custom properties structure items.

3. Fill the items with data.

Read more about custom properties in the custom properties feature documentation."

List custom property structure items

get

Gets the list of structure items in the specified custom properties structure.

Use the API call GET /custom-property-structures?{organizationId} to get the ID of the custom property structure.

Authorizations

Path parameters

customPropertyStructureIdintegerrequired

The ID of the custom property structure. Use the API call GET /custom-property-structures?organizationId={organizationId} to get the ID of a custom property structure.

Example: 2

Query parameters

cols[]string · enum[]optional

Specifies columns that are returned in the response. Use the cols[] parameter for every column that you want to return in the response. For example GET /endpoint?cols[]=key1&cols[]=key2 to get both key1 and key2 columns in the response.

Check the "Filtering" section for a full example.

pg[sortBy]string · enumoptional

Specify the custom property item attribute. The custom property items in the response are sorted by the value of the attribute.

Available options:

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.

Available options:

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

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://eu1.make.com/api/v2/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "customPropertyStructureItems": [
    {
      "id": 54,
      "name": "highPriority",
      "label": "High Priority",
      "description": "Specify whether the scenario is high priority or not.",
      "type": "boolean",
      "options": null,
      "required": false
    },
    {
      "id": 55,
      "name": "location",
      "label": "Location",
      "description": "Location of the team managing the scenario.",
      "type": "shortText",
      "options": null,
      "required": false
    },
    {
      "id": 56,
      "name": "description",
      "label": "Description",
      "description": "Custom description of the scenario.",
      "type": "longText",
      "options": null,
      "required": false
    },
    {
      "id": 57,
      "name": "customId",
      "label": "Company ID",
      "description": "ID managed by our company",
      "type": "number",
      "options": null,
      "required": true
    },
    {
      "id": 134,
      "name": "performanceCheck",
      "label": "Performance check due date",
      "description": "The date when we should check whether the scenario remains valid and can be improved.",
      "type": "string",
      "format": "date",
      "options": null,
      "required": true
    },
    {
      "id": 43,
      "name": "companyTeam",
      "label": "Company Team",
      "description": "The team that manages the scenario",
      "type": "dropdown",
      "options": [
        {
          "value": "Marketing"
        },
        {
          "value": "Product"
        },
        {
          "label": "Engineering"
        }
      ],
      "required": true
    },
    {
      "id": 53,
      "name": "category",
      "label": "Category",
      "description": "The category tags of the scenarios",
      "type": "multiselect",
      "options": [
        {
          "value": "Eshop"
        },
        {
          "value": "Notifications"
        },
        {
          "value": "Routing"
        },
        {
          "value": "Products"
        }
      ],
      "required": false
    }
  ],
  "pg": {
    "sortBy": "id",
    "limit": 10000,
    "sortDir": "asc",
    "offset": 0
  }
}

Successful response

Create a custom property structure item

post

Creates custom properties structure items.

After creating a structure item, you cannot change its name and type.

To add data to the custom properties, use the API call to fill in custom properties data.

Authorizations

Path parameters

customPropertyStructureIdintegerrequired

The ID of the custom property structure. Use the API call GET /custom-property-structures?organizationId={organizationId} to get the ID of a custom property structure.

Example: 2

Body

namestringrequired

The ID of the structure item. The name has to be unique in the custom properties structure.

labelstringrequired

Make displays the item label to users in the scenario table header.

descriptionstringoptional

The description of the custom property structure item. You can review the item description in the Scenario properties tab in the Organization dashboard.

typestring · enumrequired

The data type of the custom property structure item. The data types dropdown and multiselect allow you to specify available options for the item data.

Available options:

optionsanyoptional

The options available to users when filling in the item data. For the data types dropdown and multiselect, fill in an object like {"options":[{"value": "Marketing"}, {"value": "Sales"}]}. You can omit the options parameter for the rest of the data types.

requiredbooleanoptional

Set to true in order to make a structure item required when adding custom property data. Default value is false.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://eu1.make.com/api/v2/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "teamLocation",
    "label": "Team location",
    "description": "Location of the team managing the scenario.",
    "type": "shortText",
    "required": true
  }'

Text itemItem with options

200

200

basic-example

options-example

basic-example

{
  "customPropertyStructureItem": {
    "id": 183,
    "structureId": 6,
    "name": "teamLocation",
    "label": "Team location",
    "description": "Location of the team managing the scenario.",
    "type": "shortText",
    "options": null,
    "required": false
  }
}

Successful response

Delete custom property structure item

delete

Deletes the specified custom property structure item. Use the confirmed parameter to confirm deleting the structure item. When you delete a custom property item, Make deletes the data filled in the item as well. Deleting custom property item data is irreversible.

Authorizations

Path parameters

customPropertyStructureItemIdintegerrequired

The ID of the custom property structure item. Get the item ID with the API call to list custom property structure items.

Example: 2

Query parameters

confirmedbooleanoptionalExample: true

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://eu1.make.com/api/v2/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

{
  "customPropertyStructureItem": 2
}

Successful response

Update custom property structure item

patch

Updates the specified item of a custom property structure. Specify the attributes you want to update in the request body.

You cannot update the item name and type.

You can get the item ID with an API call to list custom property structure items.

When you want to update the options of a multiselect or dropdown item, specify all the options for the property. The new set of options replaces the current options.

Authorizations

Path parameters

customPropertyStructureItemIdintegerrequired

The ID of the custom property structure item. Get the item ID with the API call to list custom property structure items.

Example: 2

Body

labelstringoptional

Make displays the item label to users in the scenario table header.

descriptionstringoptional

The description of the custom property structure item. You can review the item description in the Scenario properties tab in the Organization dashboard.

optionsanyoptional

The options available to users when filling in the item data. For the data types dropdown and multiselect, fill in an object like {"options":[{"value": "Marketing"}, {"value": "Sales"}]}. You can omit the options parameter for the rest of the data types.

requiredbooleanoptional

Set to true if you require to fill in data to the structure item when adding custom property data. Default value is false.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://eu1.make.com/api/v2/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "label": "Updated categories"
  }'

Update custom propertyUpdate item options

200

200

update-label

update-options

update-label

{
  "customPropertyStructureItem": {
    "id": 2,
    "structureId": 11,
    "name": "categories",
    "label": "Updated categories",
    "description": "Update label of the categories.",
    "type": "multiselect",
    "options": [
      {
        "value": "Accounting"
      },
      {
        "value": "Development"
      }
    ],
    "required": true
  }
}

Successful response