メインコンテンツへスキップ
POST
/
automation
/
v4
/
actions
/
{appId}
新しいカスタムアクション定義を作成
curl --request POST \
  --url https://api.hubapi.com/automation/v4/actions/{appId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actionUrl": "<string>",
  "functions": [
    {
      "functionSource": "<string>",
      "id": "<string>"
    }
  ],
  "inputFields": [
    {
      "isRequired": true,
      "typeDefinition": {
        "name": "<string>",
        "options": [
          {
            "label": "<string>",
            "value": "<string>",
            "description": "<string>",
            "displayOrder": 123
          }
        ],
        "description": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<string>",
        "referencedObjectType": "OWNER"
      },
      "supportedValueTypes": []
    }
  ],
  "labels": {},
  "objectTypes": [
    "<string>"
  ],
  "published": true,
  "archivedAt": 123,
  "executionRules": [
    {
      "conditions": {},
      "labelName": "<string>"
    }
  ],
  "inputFieldDependencies": [
    {
      "controllingFieldName": "<string>",
      "dependencyType": "SINGLE_FIELD",
      "dependentFieldNames": [
        "<string>"
      ]
    }
  ],
  "outputFields": [
    {
      "typeDefinition": {
        "externalOptions": true,
        "name": "<string>",
        "options": [
          {
            "description": "<string>",
            "displayOrder": 123,
            "doubleData": 123,
            "hidden": true,
            "label": "<string>",
            "readOnly": true,
            "value": "<string>"
          }
        ],
        "schema": {
          "type": "INTEGER",
          "maximum": 123,
          "minimum": 123
        },
        "useChirp": true,
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<string>"
      }
    }
  ]
}
'
import requests

url = "https://api.hubapi.com/automation/v4/actions/{appId}"

payload = {
    "actionUrl": "<string>",
    "functions": [
        {
            "functionSource": "<string>",
            "id": "<string>"
        }
    ],
    "inputFields": [
        {
            "isRequired": True,
            "typeDefinition": {
                "name": "<string>",
                "options": [
                    {
                        "label": "<string>",
                        "value": "<string>",
                        "description": "<string>",
                        "displayOrder": 123
                    }
                ],
                "description": "<string>",
                "helpText": "<string>",
                "label": "<string>",
                "optionsUrl": "<string>",
                "referencedObjectType": "OWNER"
            },
            "supportedValueTypes": []
        }
    ],
    "labels": {},
    "objectTypes": ["<string>"],
    "published": True,
    "archivedAt": 123,
    "executionRules": [
        {
            "conditions": {},
            "labelName": "<string>"
        }
    ],
    "inputFieldDependencies": [
        {
            "controllingFieldName": "<string>",
            "dependencyType": "SINGLE_FIELD",
            "dependentFieldNames": ["<string>"]
        }
    ],
    "outputFields": [{ "typeDefinition": {
                "externalOptions": True,
                "name": "<string>",
                "options": [
                    {
                        "description": "<string>",
                        "displayOrder": 123,
                        "doubleData": 123,
                        "hidden": True,
                        "label": "<string>",
                        "readOnly": True,
                        "value": "<string>"
                    }
                ],
                "schema": {
                    "type": "INTEGER",
                    "maximum": 123,
                    "minimum": 123
                },
                "useChirp": True,
                "description": "<string>",
                "externalOptionsReferenceType": "<string>",
                "helpText": "<string>",
                "label": "<string>",
                "optionsUrl": "<string>"
            } }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    actionUrl: '<string>',
    functions: [{functionSource: '<string>', id: '<string>'}],
    inputFields: [
      {
        isRequired: true,
        typeDefinition: {
          name: '<string>',
          options: [
            {
              label: '<string>',
              value: '<string>',
              description: '<string>',
              displayOrder: 123
            }
          ],
          description: '<string>',
          helpText: '<string>',
          label: '<string>',
          optionsUrl: '<string>',
          referencedObjectType: 'OWNER'
        },
        supportedValueTypes: []
      }
    ],
    labels: {},
    objectTypes: ['<string>'],
    published: true,
    archivedAt: 123,
    executionRules: [{conditions: {}, labelName: '<string>'}],
    inputFieldDependencies: [
      {
        controllingFieldName: '<string>',
        dependencyType: 'SINGLE_FIELD',
        dependentFieldNames: ['<string>']
      }
    ],
    outputFields: [
      {
        typeDefinition: {
          externalOptions: true,
          name: '<string>',
          options: [
            {
              description: '<string>',
              displayOrder: 123,
              doubleData: 123,
              hidden: true,
              label: '<string>',
              readOnly: true,
              value: '<string>'
            }
          ],
          schema: {type: 'INTEGER', maximum: 123, minimum: 123},
          useChirp: true,
          description: '<string>',
          externalOptionsReferenceType: '<string>',
          helpText: '<string>',
          label: '<string>',
          optionsUrl: '<string>'
        }
      }
    ]
  })
};

fetch('https://api.hubapi.com/automation/v4/actions/{appId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.hubapi.com/automation/v4/actions/{appId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'actionUrl' => '<string>',
    'functions' => [
        [
                'functionSource' => '<string>',
                'id' => '<string>'
        ]
    ],
    'inputFields' => [
        [
                'isRequired' => true,
                'typeDefinition' => [
                                'name' => '<string>',
                                'options' => [
                                                                [
                                                                                                                                'label' => '<string>',
                                                                                                                                'value' => '<string>',
                                                                                                                                'description' => '<string>',
                                                                                                                                'displayOrder' => 123
                                                                ]
                                ],
                                'description' => '<string>',
                                'helpText' => '<string>',
                                'label' => '<string>',
                                'optionsUrl' => '<string>',
                                'referencedObjectType' => 'OWNER'
                ],
                'supportedValueTypes' => [
                                
                ]
        ]
    ],
    'labels' => [
        
    ],
    'objectTypes' => [
        '<string>'
    ],
    'published' => true,
    'archivedAt' => 123,
    'executionRules' => [
        [
                'conditions' => [
                                
                ],
                'labelName' => '<string>'
        ]
    ],
    'inputFieldDependencies' => [
        [
                'controllingFieldName' => '<string>',
                'dependencyType' => 'SINGLE_FIELD',
                'dependentFieldNames' => [
                                '<string>'
                ]
        ]
    ],
    'outputFields' => [
        [
                'typeDefinition' => [
                                'externalOptions' => true,
                                'name' => '<string>',
                                'options' => [
                                                                [
                                                                                                                                'description' => '<string>',
                                                                                                                                'displayOrder' => 123,
                                                                                                                                'doubleData' => 123,
                                                                                                                                'hidden' => true,
                                                                                                                                'label' => '<string>',
                                                                                                                                'readOnly' => true,
                                                                                                                                'value' => '<string>'
                                                                ]
                                ],
                                'schema' => [
                                                                'type' => 'INTEGER',
                                                                'maximum' => 123,
                                                                'minimum' => 123
                                ],
                                'useChirp' => true,
                                'description' => '<string>',
                                'externalOptionsReferenceType' => '<string>',
                                'helpText' => '<string>',
                                'label' => '<string>',
                                'optionsUrl' => '<string>'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.hubapi.com/automation/v4/actions/{appId}"

	payload := strings.NewReader("{\n  \"actionUrl\": \"<string>\",\n  \"functions\": [\n    {\n      \"functionSource\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"inputFields\": [\n    {\n      \"isRequired\": true,\n      \"typeDefinition\": {\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"label\": \"<string>\",\n            \"value\": \"<string>\",\n            \"description\": \"<string>\",\n            \"displayOrder\": 123\n          }\n        ],\n        \"description\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\",\n        \"referencedObjectType\": \"OWNER\"\n      },\n      \"supportedValueTypes\": []\n    }\n  ],\n  \"labels\": {},\n  \"objectTypes\": [\n    \"<string>\"\n  ],\n  \"published\": true,\n  \"archivedAt\": 123,\n  \"executionRules\": [\n    {\n      \"conditions\": {},\n      \"labelName\": \"<string>\"\n    }\n  ],\n  \"inputFieldDependencies\": [\n    {\n      \"controllingFieldName\": \"<string>\",\n      \"dependencyType\": \"SINGLE_FIELD\",\n      \"dependentFieldNames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"outputFields\": [\n    {\n      \"typeDefinition\": {\n        \"externalOptions\": true,\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"description\": \"<string>\",\n            \"displayOrder\": 123,\n            \"doubleData\": 123,\n            \"hidden\": true,\n            \"label\": \"<string>\",\n            \"readOnly\": true,\n            \"value\": \"<string>\"\n          }\n        ],\n        \"schema\": {\n          \"type\": \"INTEGER\",\n          \"maximum\": 123,\n          \"minimum\": 123\n        },\n        \"useChirp\": true,\n        \"description\": \"<string>\",\n        \"externalOptionsReferenceType\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\"\n      }\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.hubapi.com/automation/v4/actions/{appId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"actionUrl\": \"<string>\",\n  \"functions\": [\n    {\n      \"functionSource\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"inputFields\": [\n    {\n      \"isRequired\": true,\n      \"typeDefinition\": {\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"label\": \"<string>\",\n            \"value\": \"<string>\",\n            \"description\": \"<string>\",\n            \"displayOrder\": 123\n          }\n        ],\n        \"description\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\",\n        \"referencedObjectType\": \"OWNER\"\n      },\n      \"supportedValueTypes\": []\n    }\n  ],\n  \"labels\": {},\n  \"objectTypes\": [\n    \"<string>\"\n  ],\n  \"published\": true,\n  \"archivedAt\": 123,\n  \"executionRules\": [\n    {\n      \"conditions\": {},\n      \"labelName\": \"<string>\"\n    }\n  ],\n  \"inputFieldDependencies\": [\n    {\n      \"controllingFieldName\": \"<string>\",\n      \"dependencyType\": \"SINGLE_FIELD\",\n      \"dependentFieldNames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"outputFields\": [\n    {\n      \"typeDefinition\": {\n        \"externalOptions\": true,\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"description\": \"<string>\",\n            \"displayOrder\": 123,\n            \"doubleData\": 123,\n            \"hidden\": true,\n            \"label\": \"<string>\",\n            \"readOnly\": true,\n            \"value\": \"<string>\"\n          }\n        ],\n        \"schema\": {\n          \"type\": \"INTEGER\",\n          \"maximum\": 123,\n          \"minimum\": 123\n        },\n        \"useChirp\": true,\n        \"description\": \"<string>\",\n        \"externalOptionsReferenceType\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\"\n      }\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/automation/v4/actions/{appId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"actionUrl\": \"<string>\",\n  \"functions\": [\n    {\n      \"functionSource\": \"<string>\",\n      \"id\": \"<string>\"\n    }\n  ],\n  \"inputFields\": [\n    {\n      \"isRequired\": true,\n      \"typeDefinition\": {\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"label\": \"<string>\",\n            \"value\": \"<string>\",\n            \"description\": \"<string>\",\n            \"displayOrder\": 123\n          }\n        ],\n        \"description\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\",\n        \"referencedObjectType\": \"OWNER\"\n      },\n      \"supportedValueTypes\": []\n    }\n  ],\n  \"labels\": {},\n  \"objectTypes\": [\n    \"<string>\"\n  ],\n  \"published\": true,\n  \"archivedAt\": 123,\n  \"executionRules\": [\n    {\n      \"conditions\": {},\n      \"labelName\": \"<string>\"\n    }\n  ],\n  \"inputFieldDependencies\": [\n    {\n      \"controllingFieldName\": \"<string>\",\n      \"dependencyType\": \"SINGLE_FIELD\",\n      \"dependentFieldNames\": [\n        \"<string>\"\n      ]\n    }\n  ],\n  \"outputFields\": [\n    {\n      \"typeDefinition\": {\n        \"externalOptions\": true,\n        \"name\": \"<string>\",\n        \"options\": [\n          {\n            \"description\": \"<string>\",\n            \"displayOrder\": 123,\n            \"doubleData\": 123,\n            \"hidden\": true,\n            \"label\": \"<string>\",\n            \"readOnly\": true,\n            \"value\": \"<string>\"\n          }\n        ],\n        \"schema\": {\n          \"type\": \"INTEGER\",\n          \"maximum\": 123,\n          \"minimum\": 123\n        },\n        \"useChirp\": true,\n        \"description\": \"<string>\",\n        \"externalOptionsReferenceType\": \"<string>\",\n        \"helpText\": \"<string>\",\n        \"label\": \"<string>\",\n        \"optionsUrl\": \"<string>\"\n      }\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "actionUrl": "<string>",
  "functions": [
    {
      "id": "<string>"
    }
  ],
  "id": "<string>",
  "inputFields": [
    {
      "isRequired": true,
      "typeDefinition": {
        "name": "<string>",
        "options": [
          {
            "label": "<string>",
            "value": "<string>",
            "description": "<string>",
            "displayOrder": 123
          }
        ],
        "description": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<string>",
        "referencedObjectType": "OWNER"
      },
      "supportedValueTypes": []
    }
  ],
  "labels": {},
  "objectTypes": [
    "<string>"
  ],
  "published": true,
  "revisionId": "<string>",
  "archivedAt": 123,
  "executionRules": [
    {
      "conditions": {},
      "labelName": "<string>"
    }
  ],
  "inputFieldDependencies": [
    {
      "controllingFieldName": "<string>",
      "dependencyType": "SINGLE_FIELD",
      "dependentFieldNames": [
        "<string>"
      ]
    }
  ],
  "objectRequestOptions": {
    "properties": [
      "<string>"
    ]
  },
  "outputFields": [
    {
      "typeDefinition": {
        "externalOptions": true,
        "name": "<string>",
        "options": [
          {
            "description": "<string>",
            "displayOrder": 123,
            "doubleData": 123,
            "hidden": true,
            "label": "<string>",
            "readOnly": true,
            "value": "<string>"
          }
        ],
        "schema": {
          "type": "INTEGER",
          "maximum": 123,
          "minimum": 123
        },
        "useChirp": true,
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "helpText": "<string>",
        "label": "<string>",
        "optionsUrl": "<string>"
      }
    }
  ]
}
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

​
appId
integer<int32>
必須

アプリの固有ID。

ボディ

application/json
​
actionUrl
string
必須

アクションが実行されるURLエンドポイント。

​
functions
object[]
必須
​
inputFields
object[]
必須
​
labels
object
必須

名前や説明を含む、アクションに関連付けられたさまざまなラベルを保持します。

​
objectTypes
string[]
必須
​
published
boolean
必須

アクションが公開され、使用可能であるかどうかを示します。

​
archivedAt
integer<int64>

アクションがアーカイブされた日時を示すタイムスタンプ。

​
executionRules
object[]
​
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
​
objectRequestOptions
object
​
outputFields
object[]

レスポンス

successful operation

​
actionUrl
string
必須
​
functions
object[]
必須
​
id
string
必須
​
inputFields
object[]
必須
​
labels
object
必須
​
objectTypes
string[]
必須
​
published
boolean
必須
​
revisionId
string
必須
​
archivedAt
integer<int64>
​
executionRules
object[]
​
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
​
objectRequestOptions
object
​
outputFields
object[]
最終更新日 2026年4月10日