SDK Apps > Modules

List App Modules

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

Responses

200

Successful response

application/json

get

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules

HTTPcURLJavaScriptPython

GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "appModules": [
    {
      "name": "postmanModule5",
      "label": "BezVisKam",
      "typeId": 1,
      "public": false,
      "approved": false,
      "description": "Bleeeeee",
      "crud": "read"
    },
    {
      "name": "getEntity",
      "label": "Get Entity",
      "typeId": 4,
      "public": false,
      "approved": false,
      "description": "Retrieves the given entity.",
      "crud": null
    }
  ]
}

Create Module

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

Body

application/json

namestringRequired

typeIdinteger · enumRequired

Module type id. Allowed values:

• 1 = TRIGGER (Trigger - polling) Use if you wish to watch for any changes in your app/service. Examples are Watch a New Book, which will be triggered whenever a new book has been added to the library.
• 4 = ACTION Use if the API endpoint returns a single response. Examples are Create a book, Delete a book or Get a Book.
• 9 = SEARCH Use if the API endpoint returns multiple items. An example is List Books that will find specific books according to search criteria.
• 10 = CONVERGER (Instant Trigger / webhook) Use if the API endpoint has a webhook available (dedicated or shared). Example is Watch a New Event.
• 11 = HITL (Responder) Use if you need to send a processed data back to a webhook.
• 12 = RETURNER (Universal) Use if you want to enable users to perform an arbitrary API call to the service. Examples are Make an API Call and Execute a GraphQL Query.

Default: 4Possible values:

labelstringOptional

descriptionstringOptional

moduleInitModestring · enumOptional

Module init mode:

• blank - Creates a new blank module (code is empty).
• example - Creates a module from a model app (which contains the example codes).
• module - Creates module from existing user's module.

Default: blankPossible values:

moduleInitSourcestringOptional

Required when moduleInitMode is module. Specifies the name of the source module to clone.

connectionstring | nullableOptional

The name of the connection to use.

webhookstring | nullableOptional

The name of the webhook to use.

crudstring | nullableOptional

The CRUD operation type.

Responses

200

Successful response

application/json

post

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules

HTTPcURLJavaScriptPython

POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "name": "getEntity",
  "typeId": 4,
  "label": "Get Entity",
  "description": "Retrieves the given entity.",
  "moduleInitMode": "blank",
  "connection": null,
  "webhook": null,
  "crud": null
}

200

Successful response

{
  "appModule": {
    "name": "getEntity",
    "label": "Get Entity",
    "description": "Retrieves the given entity.",
    "typeId": 4,
    "crud": null,
    "connection": null,
    "webhook": null
  }
}

Get Module

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Responses

200

Successful response

application/json

get

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

HTTPcURLJavaScriptPython

GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "appModule": {
    "name": "getEntity",
    "label": "Get Entity",
    "description": "Retrieves the given entity.",
    "typeId": 4,
    "public": false,
    "approved": false,
    "crud": null,
    "connection": null,
    "altConnection": null,
    "webhook": null
  }
}

Delete Module

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Responses

200

Successful response

application/json

delete

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

HTTPcURLJavaScriptPython

DELETE /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "appModule": "getEntity"
}

Patch Module

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

Updates a module.

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/json

labelstringOptional

descriptionstringOptional

connectionstringOptional

Responses

200

Successful response

application/json

patch

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}

HTTPcURLJavaScriptPython

PATCH /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "label": "Get Order",
  "description": "Retrieves the order by its id.",
  "connection": "charlie-1"
}

200

Successful response

{
  "appModule": {
    "name": "getEntity",
    "label": "Get Order",
    "description": "Retrieves the order by its id.",
    "typeId": 4,
    "crud": null,
    "connection": "charlie-1",
    "altConnection": null,
    "webhook": null
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/api

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/jsonapplication/jsonc

any ofOptional

or

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/api

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/api HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1724

{
  "url": "text",
  "baseUrl": "text",
  "encodeUrl": true,
  "method": "GET",
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "qs": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "ca": "text",
  "body": {},
  "type": "json",
  "temp": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "condition": true,
  "aws": {
    "key": "text",
    "secret": "text",
    "session": "text",
    "bucket": "text",
    "sign_version": "2"
  },
  "gzip": false,
  "followRedirects": true,
  "followAllRedirects": true,
  "log": {
    "sanitize": [
      "text"
    ]
  },
  "oauth": {
    "consumer_key": "text",
    "consumer_secret": "text",
    "private_key": "text",
    "token": "text",
    "token_secret": "text",
    "verifier": "text",
    "signature_method": "HMAC-SHA1",
    "transport_method": "header",
    "body_hash": true
  },
  "pagination": {
    "mergeWithParent": true,
    "url": "text",
    "method": "GET",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "qs": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "body": {},
    "condition": true
  },
  "response": {
    "type": {
      "ANY_ADDITIONAL_PROPERTY": "automatic"
    },
    "valid": true,
    "limit": 1,
    "error": "text",
    "iterate": "text",
    "temp": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "output": {},
    "trigger": {
      "type": "date",
      "order": "asc",
      "id": "text",
      "date": "text"
    },
    "data": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "value": "text",
      "type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "uid": "text",
    "oauth": {
      "consumer_key": "text",
      "consumer_secret": "text",
      "private_key": "text",
      "token": "text",
      "token_secret": "text",
      "verifier": "text",
      "signature_method": "HMAC-SHA1",
      "transport_method": "header",
      "body_hash": true
    },
    "wrapper": "{{output}}",
    "expires": "text"
  },
  "output": {},
  "iterate": "text",
  "respond": {
    "type": "json",
    "status": 1,
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "body": {}
  },
  "verification": {
    "condition": true,
    "respond": {
      "type": "json",
      "status": 1,
      "headers": {
        "ANY_ADDITIONAL_PROPERTY": true
      },
      "body": {}
    }
  },
  "repeat": {
    "condition": "text",
    "delay": 1,
    "limit": 1
  }
}

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/epoch

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/jsonapplication/jsonc

urlstring · min: 1 · max: 512Optional

Request URL

encodeUrlbooleanOptional

This directive controls the encoding of URLs. It is on by default, so if you have any special characters in your URL, they will be automatically encoded. But there might be situations where you don't want your URL to be encoded automatically, or you want to control what parts of the URL are encoded. To do this, set this flag to false.

Default: true

methodany ofOptional

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

stringOptionalPattern: ^.*[{][{].*[}][}].*$

castring · max: 8192Optional

Custom Certificate Authority

bodyany ofOptional

Request body

objectOptional

or

or

booleanOptional

or

integerOptional

or

string | nullableOptional

or

numberOptional

or

stringOptional

typeany ofOptional

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

string · enumOptionalPossible values:

or

stringOptionalPattern: ^.*[{][{].*[}][}].*$

conditionany ofOptionalDefault: true

booleanOptional

or

stringOptional

or

gzipbooleanOptional

Add an Accept-Encoding header to request compressed content encodings from the server (if not already present) and decode supported content encodings in the response.

Default: false

followRedirectsbooleanOptional

This directive specifies whether to follow GET HTTP 3xx responses as redirects or never.

Default: true

followAllRedirectsbooleanOptional

This directive specifies whether to follow non-GET HTTP 3xx responses as redirects or never.

Default: true

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/epoch

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/epoch HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1281

{
  "url": "text",
  "encodeUrl": true,
  "method": "GET",
  "headers": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "qs": {
    "ANY_ADDITIONAL_PROPERTY": true
  },
  "ca": "text",
  "body": {},
  "type": "json",
  "temp": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "condition": true,
  "aws": {
    "key": "text",
    "secret": "text",
    "session": "text",
    "bucket": "text",
    "sign_version": "2"
  },
  "oauth": {
    "consumer_key": "text",
    "consumer_secret": "text",
    "private_key": "text",
    "token": "text",
    "token_secret": "text",
    "verifier": "text",
    "signature_method": "HMAC-SHA1",
    "transport_method": "header",
    "body_hash": true
  },
  "gzip": false,
  "followRedirects": true,
  "followAllRedirects": true,
  "log": {
    "sanitize": [
      "text"
    ]
  },
  "pagination": {
    "mergeWithParent": true,
    "url": "text",
    "method": "GET",
    "headers": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "qs": {
      "ANY_ADDITIONAL_PROPERTY": true
    },
    "body": {},
    "condition": true
  },
  "repeat": {
    "condition": "text",
    "delay": 1,
    "limit": 1
  },
  "response": {
    "type": {
      "ANY_ADDITIONAL_PROPERTY": "automatic"
    },
    "valid": true,
    "limit": 1,
    "error": "text",
    "iterate": "text",
    "temp": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "output": {
      "date": null,
      "label": null,
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "oauth": {
      "consumer_key": "text",
      "consumer_secret": "text",
      "private_key": "text",
      "token": "text",
      "token_secret": "text",
      "verifier": "text",
      "signature_method": "HMAC-SHA1",
      "transport_method": "header",
      "body_hash": true
    }
  }
}

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/interface

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/jsonapplication/jsonc

any ofOptional

or

stringOptional

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/interface

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/interface HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 868

[
  {
    "name": "text",
    "label": "text",
    "help": "text",
    "type": "any",
    "semantic": "text",
    "default": true,
    "advanced": true,
    "required": true,
    "grouped": true,
    "dynamic": true,
    "multiline": true,
    "sort": "text",
    "sequence": true,
    "schema": null,
    "tags": "strip",
    "coder": true,
    "multiple": true,
    "visible": "text",
    "convert": {
      "type": "text",
      "format": "text",
      "timezone": "text",
      "name": "text",
      "label": "text",
      "names": "text"
    },
    "editable": true,
    "mappable": true,
    "time": true,
    "rpc": {
      "url": "text",
      "label": "text",
      "parameters": []
    },
    "mode": "edit",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "spec": null,
    "codepage": "text",
    "pattern": "text",
    "nested": null,
    "options": [
      {
        "label": "text",
        "value": "text",
        "description": "text",
        "nested": null,
        "default": true,
        "short": "text"
      }
    ],
    "extension": "text",
    "validate": true,
    "title": "text",
    "text": "text",
    "closable": true,
    "theme": "text",
    "badge": "text"
  }
]

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/parameters

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/jsonapplication/jsonc

any ofOptional

or

stringOptional

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/parameters

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/parameters HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 868

[
  {
    "name": "text",
    "label": "text",
    "help": "text",
    "type": "any",
    "semantic": "text",
    "default": true,
    "advanced": true,
    "required": true,
    "grouped": true,
    "dynamic": true,
    "multiline": true,
    "sort": "text",
    "sequence": true,
    "schema": null,
    "tags": "strip",
    "coder": true,
    "multiple": true,
    "visible": "text",
    "convert": {
      "type": "text",
      "format": "text",
      "timezone": "text",
      "name": "text",
      "label": "text",
      "names": "text"
    },
    "editable": true,
    "mappable": true,
    "time": true,
    "rpc": {
      "url": "text",
      "label": "text",
      "parameters": []
    },
    "mode": "edit",
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "spec": null,
    "codepage": "text",
    "pattern": "text",
    "nested": null,
    "options": [
      {
        "label": "text",
        "value": "text",
        "description": "text",
        "nested": null,
        "default": true,
        "short": "text"
      }
    ],
    "extension": "text",
    "validate": true,
    "title": "text",
    "text": "text",
    "closable": true,
    "theme": "text",
    "badge": "text"
  }
]

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/samples

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/jsonapplication/jsonc

Other propertiesanyOptional

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/samples

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/samples HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Section

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/scope

Available sections: api, epoch, parameters, expect, interface, samples, scope

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Bodystring[]

application/jsonapplication/jsonc

string[]Optional

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/scope

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/scope HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

application/jsonapplication/jsonc

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Get Module Section

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleSection}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleSectionstring · enumRequiredPossible values:

Responses

200

Successful response

application/json

get

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleSection}

HTTPcURLJavaScriptPython

GET /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleSection} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "url": "/api/users",
  "method": "GET",
  "qs": {},
  "body": {},
  "headers": {},
  "response": {
    "iterate": "{{body.users}}",
    "trigger": {
      "id": "{{item.id}}",
      "date": "{{item.created}}",
      "type": "string",
      "format": "date",
      "order": "desc"
    },
    "output": "{{item}}",
    "limit": "{{parameters.limit}}"
  }
}

Set Module Visibility

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleVisibility}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleVisibilitystring · enumRequiredPossible values:

Body

Responses

200

Successful response

application/json

post

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleVisibility}

HTTPcURLJavaScriptPython

POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleVisibility} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "changed": true
}

Clone Module

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/clone

Creates a duplicate of a module.

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/json

newNamestringOptional

labelstringOptional

Responses

200

Successful response

application/json

post

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/clone

HTTPcURLJavaScriptPython

POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/clone HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "newName": "apicek",
  "label": "Testicek (clone)"
}

200

Successful response

{
  "module": {
    "name": "apicek",
    "label": "Testicek (clone)",
    "description": "Těstíčko.",
    "typeId": 4,
    "connection": "multiverse",
    "webhook": null,
    "crud": null
  }
}

Set Module Deprecation

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleDeprecation}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleDeprecationstring · enumRequiredPossible values:

Body

Responses

200

Successful response

application/json

post

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleDeprecation}

HTTPcURLJavaScriptPython

POST /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleDeprecation} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "changed": true
}

Set Module Consumable

put

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

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleConsumable}

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

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Body

application/json

centicreditsFormulastringOptional

centicreditsFormulaDescriptionstringOptional

centicreditsFormulaDocumentationUrlstringOptional

centicreditsFormulaMetastringOptional

Responses

200

Successful response

application/json

put

/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleConsumable}

HTTPcURLJavaScriptPython

PUT /api/v2/sdk/apps/{SDK_appName}/{SDK_appVersion}/modules/{SDK_moduleName}/{SDK_moduleConsumable} HTTP/1.1
Host: eu1.make.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 178

{
  "centicreditsFormula": "1+1",
  "centicreditsFormulaDescription": "A simple formula.",
  "centicreditsFormulaDocumentationUrl": "https://example.com/docs",
  "centicreditsFormulaMeta": "{}"
}

200

Successful response

{
  "name": "the-module-name"
}