SDK Apps > Modules

PreviousSDK Apps > Invites NextSDK Apps > RPCs

Get Module

get

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Responses

application/json

objectOptional

get

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

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Responses

application/json

objectOptional

delete

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

Get Module Section

get

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

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleSectionstringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Responses

application/json

objectOptional

get

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

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleVisibilitystringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Content-TypestringOptionalExample: text/plain

Body

Responses

text/plain

booleanOptional

post

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 respons

true

Set Module Deprecation

post

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleDeprecationstringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Content-TypestringOptionalExample: text/plain

Body

Responses

application/json

objectOptional

post

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
}

List App Modules

get

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Responses

application/json

objectOptional

get

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

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Content-TypestringOptionalExample: application/json

Body

namestringOptional

typeIdintegerOptional

labelstringOptional

descriptionstringOptional

Responses

application/json

objectOptional

post

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

{
  "name": "getEntity",
  "typeId": 4,
  "label": "Get Entity",
  "description": "Retrieves the given entity."
}

200

Successful response

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

Patch Module

patch

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Content-TypestringOptionalExample: application/json

Body

labelstringOptional

descriptionstringOptional

connectionstringOptional

Responses

application/json

objectOptional

patch

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

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

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

SDK_moduleSectionstringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Content-TypestringOptionalExample: application/jsonc

Body

urlstringOptional

methodstringOptional

qsobjectOptional

bodyobjectOptional

headersobjectOptional

responseobjectOptional

Responses

application/json

objectOptional

put

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

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

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

Clone Module

post

Retrieves a list of all apps available to the user.

Authorizations

Path parameters

SDK_appNamestringRequired

SDK_appVersionstringRequired

SDK_moduleNamestringRequired

Query parameters

allbooleanOptionalExample: true

opensourcebooleanOptionalExample: true

Header parameters

imt-adminintegerOptionalExample: 1

Body

newNamestringOptional

Responses

application/json

objectOptional

post

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

{
  "newName": "apicek"
}

200

Successful response

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