Get support

Scenarios > Custom properties data

The following endpoints allow you to manage custom scenario properties data.

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.

Get custom properties data

get

Gets custom properties data of the specified scenario.

Authorizations
Path parameters
scenarioIdintegerRequired

The ID of the scenario.

Example: 22
Responses
200
Successful response
application/json
get
GET /api/v2/scenarios/{scenarioId}/custom-properties HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "customProperties": {
    "category": [
      "notifications",
      "routing"
    ],
    "customId": 45,
    "location": "London, UK",
    "companyTeam": "Product",
    "description": "This scenario handles notifications for the Product team in London.",
    "highPriority": true,
    "performanceCheck": "2023-08-31T14:19:00.000Z"
  },
  "scenarioId": 22
}

Fill in custom properties data

post

Fills in custom properties data for the specified scenario. The scenario has to have no custom properties data.

The data you fill in has to conform to the current custom scenario properties structure. You have to specify a value for every required item, otherwise you get an error.

To update existing data, use the following API calls:

  • Update custom properties data

  • Set custom properties data

Authorizations
Path parameters
scenarioIdintegerRequired

The ID of the scenario.

Example: 80
Body
objectOptional
Responses
200
Successful response
application/json
post
POST /api/v2/scenarios/{scenarioId}/custom-properties HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 248

{
  "companyTeam": "marketing",
  "customId": 60,
  "performanceCheck": "2024-09-31T14:19:00.000Z",
  "category": [
    "eshop"
  ],
  "highPriority": false,
  "location": "Chicago, US",
  "description": "Scenario for the Marketing team to share information with other stakeholders."
}
200

Successful response

{
  "customProperties": {
    "category": [
      "eshop"
    ],
    "customId": 60,
    "location": "Chicago, US",
    "companyTeam": "marketing",
    "description": "Scenario for the Marketing team to share information with other stakeholders.",
    "highPriority": false,
    "performanceCheck": "2024-10-01T14:19:00.000Z"
  },
  "scenarioId": 80
}

Set custom properties

put

Sets custom properties data for the specified scenario. Make replaces the original data with the data you send in the request body.

You have to specify a value for every required custom properties structure item, otherwise you get an error.

The scenario has to have custom property data already. The new data set has to conform to the current custom scenario properties structure. If the initial data is empty, then the API call returns an error.

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

Authorizations
Path parameters
scenarioIdintegerRequired

The ID of the scenario.

Example: 80
Body
objectOptional
Responses
200
Successful response
application/json
put
PUT /api/v2/scenarios/{scenarioId}/custom-properties HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 230

{
  "companyTeam": "engineering",
  "customId": 50,
  "performanceCheck": "2024-08-31T14:19:00.000Z",
  "category": [
    "notifications",
    "routing"
  ],
  "highPriority": false,
  "location": "London, UK",
  "description": "Scenario for the London engineering team"
}
200

Successful response

{
  "customProperties": {
    "category": [
      "notifications",
      "routing"
    ],
    "customId": 50,
    "location": "London, UK",
    "companyTeam": "engineering",
    "description": "Scenario for the London engineering team",
    "highPriority": false,
    "performanceCheck": "2024-08-31T14:19:00.000Z"
  },
  "scenarioId": 80
}

Delete custom properties data

delete

Deletes custom properties data. Deleting custom properties data is irreversible. Use the confirmed parameter to confirm deleting the data, otherwise you get an error and the data are not deleted.

Authorizations
Path parameters
scenarioIdintegerRequired

The ID of the scenario.

Example: 28
Query parameters
confirmedbooleanOptionalExample: true
Responses
200
Successful response
application/json
delete
DELETE /api/v2/scenarios/{scenarioId}/custom-properties HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*
200

Successful response

{
  "ok": 1
}

Update custom properties data

patch

Updates custom properties data of the specified scenario. Make updates only the custom properties data you specify in the request body.

The custom property has to contain data already. The update data have to conform to the current custom scenario properties structure. If the initial value is empty, then the API call returns an error.

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

Authorizations
Path parameters
scenarioIdintegerRequired

The ID of the scenario.

Example: 80
Body
objectOptional
Responses
200
Successful response
application/json
patch
PATCH /api/v2/scenarios/{scenarioId}/custom-properties HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "customId": 48,
  "location": "Wien, AUS"
}
200

Successful response

{
  "customProperties": {
    "category": [
      "eshop",
      "products"
    ],
    "customId": 48,
    "location": "Wien, AUS",
    "companyTeam": "Product",
    "description": "This scenario is handling notifications for the Product team in London.",
    "highPriority": true,
    "performanceCheck": "2023-08-31T14:19:00.000Z"
  },
  "scenarioId": 80
}
PreviousScenarios > ConsumptionsNextScenarios folders