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

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

/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items

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.

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

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

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.

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

/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items

HTTPcURLJavaScriptPython

GET /api/v2/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "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
  }
}

Create a custom property structure item

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

/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items

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.

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

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

application/json

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.

Possible values:

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

200

Successful response

application/json

post

/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items

HTTPcURLJavaScriptPython

POST /api/v2/custom-property-structures/{customPropertyStructureId}/custom-property-structure-items HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "name": "teamLocation",
  "label": "Team location",
  "description": "Location of the team managing the scenario.",
  "type": "shortText",
  "required": true
}

Text itemItem with options

200

Successful response

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

Delete custom property structure item

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

/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}

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.

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

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

200

Successful response

application/json

customPropertyStructureItemnumberOptional

delete

/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}

HTTPcURLJavaScriptPython

DELETE /api/v2/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Accept: */*

200

Successful response

{
  "customPropertyStructureItem": 2
}

Update custom property structure item

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

/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}

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.

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

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

application/json

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

200

Successful response

application/json

patch

/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId}

HTTPcURLJavaScriptPython

PATCH /api/v2/custom-property-structures/custom-property-structure-items/{customPropertyStructureItemId} HTTP/1.1
Host: eu1.make.com
Authorization: Token your-api-token
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "label": "Updated categories"
}

Update custom propertyUpdate item options

200

Successful response

{
  "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
  }
}