Custom properties

The following endpoints allow you to create and list custom property structures.

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

/custom-property-structures

Gets a list of custom properties structures in the organization.

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

organizationIdintegerRequired

The ID of the organization.

Example: 57

Responses

200

Successful response

application/json

get

/custom-property-structures

HTTPcURLJavaScriptPython

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

200

Successful response

{
  "customPropertyStructures": [
    {
      "id": 2,
      "created": "2023-06-27T22:00:00.000Z",
      "belongers": [
        {
          "belongerId": 57,
          "belongerType": "organization",
          "associatedTypes": [
            "scenario"
          ]
        }
      ]
    }
  ]
}

Create a custom property 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

/custom-property-structures

Creates a custom properties structure. You can have only one custom properties structure for each combination of associatedType, belongerTypeand belongerId values.

For example, you can create only one custom properties structure for scenarios in a specific organization.

To create a structure for custom scenario properties, fill in the request body:

• associatedType: scenario

• belongerType: organization

Check out the example API call.

To define the custom properties structure items, use the API call to create custom properties structure item.

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

associatedTypestringRequired

The type of the entity which uses the custom properties structure. Fill in scenario to create custom scenario properties structure.

belongerTypestringRequired

The type of the entity that owns the custom properties structure. Fill in organization to create custom scenario properties structure.

belongerIdintegerRequired

The ID of the entity that owns the custom properties structure.

Responses

200

Successful response

application/json

post

/custom-property-structures

HTTPcURLJavaScriptPython

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

{
  "associatedType": "scenario",
  "belongerType": "organization",
  "belongerId": 57
}

200

Successful response

{
  "customPropertyStructure": {
    "id": 2,
    "belongers": [
      {
        "belongerId": 57,
        "belongerType": "organization",
        "associatedTypes": [
          "scenario"
        ]
      }
    ],
    "created": "2023-06-27T22:00:00.000Z"
  }
}