Zum Hauptinhalt springen
POST
/
automation
/
v4
/
actions
/
{appId}
Eine neue benutzerdefinierte Aktionsdefinitionen erstellen
curl --request POST \
  --url https://api.hubapi.com/automation/v4/actions/{appId} \
  --header 'Content-Type: application/json' \
  --data '{
  "inputFields": [
    {
      "isRequired": true,
      "automationFieldType": "<string>",
      "typeDefinition": {
        "helpText": "<string>",
        "referencedObjectType": "CONTACT",
        "name": "<string>",
        "options": [
          {
            "hidden": true,
            "displayOrder": 123,
            "doubleData": 123,
            "description": "<string>",
            "readOnly": true,
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "label": "<string>",
        "type": "string",
        "fieldType": "booleancheckbox",
        "optionsUrl": "<string>",
        "externalOptions": true
      },
      "supportedValueTypes": [
        "STATIC_VALUE"
      ]
    }
  ],
  "outputFields": [
    {
      "typeDefinition": {
        "helpText": "<string>",
        "referencedObjectType": "CONTACT",
        "name": "<string>",
        "options": [
          {
            "hidden": true,
            "displayOrder": 123,
            "doubleData": 123,
            "description": "<string>",
            "readOnly": true,
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "label": "<string>",
        "type": "string",
        "fieldType": "booleancheckbox",
        "optionsUrl": "<string>",
        "externalOptions": true
      }
    }
  ],
  "archivedAt": 123,
  "functions": [
    {
      "functionSource": "<string>",
      "functionType": "PRE_ACTION_EXECUTION",
      "id": "<string>"
    }
  ],
  "actionUrl": "<string>",
  "inputFieldDependencies": [
    {
      "dependencyType": "SINGLE_FIELD",
      "controllingFieldName": "<string>",
      "dependentFieldNames": [
        "<string>"
      ]
    }
  ],
  "published": true,
  "executionRules": [
    {
      "labelName": "<string>",
      "conditions": {}
    }
  ],
  "objectTypes": [
    "<string>"
  ],
  "objectRequestOptions": {
    "properties": [
      "<string>"
    ]
  },
  "labels": {}
}'
{
  "functions": [
    {
      "functionType": "PRE_ACTION_EXECUTION",
      "id": "<string>"
    }
  ],
  "actionUrl": "<string>",
  "published": true,
  "labels": {},
  "inputFields": [
    {
      "isRequired": true,
      "automationFieldType": "<string>",
      "typeDefinition": {
        "helpText": "<string>",
        "referencedObjectType": "CONTACT",
        "name": "<string>",
        "options": [
          {
            "hidden": true,
            "displayOrder": 123,
            "doubleData": 123,
            "description": "<string>",
            "readOnly": true,
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "label": "<string>",
        "type": "string",
        "fieldType": "booleancheckbox",
        "optionsUrl": "<string>",
        "externalOptions": true
      },
      "supportedValueTypes": [
        "STATIC_VALUE"
      ]
    }
  ],
  "outputFields": [
    {
      "typeDefinition": {
        "helpText": "<string>",
        "referencedObjectType": "CONTACT",
        "name": "<string>",
        "options": [
          {
            "hidden": true,
            "displayOrder": 123,
            "doubleData": 123,
            "description": "<string>",
            "readOnly": true,
            "label": "<string>",
            "value": "<string>"
          }
        ],
        "description": "<string>",
        "externalOptionsReferenceType": "<string>",
        "label": "<string>",
        "type": "string",
        "fieldType": "booleancheckbox",
        "optionsUrl": "<string>",
        "externalOptions": true
      }
    }
  ],
  "revisionId": "<string>",
  "archivedAt": 123,
  "inputFieldDependencies": [
    {
      "dependencyType": "SINGLE_FIELD",
      "controllingFieldName": "<string>",
      "dependentFieldNames": [
        "<string>"
      ]
    }
  ],
  "executionRules": [
    {
      "labelName": "<string>",
      "conditions": {}
    }
  ],
  "id": "<string>",
  "objectTypes": [
    "<string>"
  ],
  "objectRequestOptions": {
    "properties": [
      "<string>"
    ]
  }
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubKostenlos

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer
required

Die ID der App.

Body

application/json
inputFields
object[]
required
functions
object[]
required
actionUrl
string
required
published
boolean
required
objectTypes
string[]
required
labels
object
required
outputFields
object[]
archivedAt
integer
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
  • SINGLE_FIELD
  • CONDITIONAL_SINGLE_FIELD
executionRules
object[]
objectRequestOptions
object

Response

successful operation

functions
object[]
required
actionUrl
string
required
published
boolean
required
labels
object
required
inputFields
object[]
required
revisionId
string
required
id
string
required
objectTypes
string[]
required
outputFields
object[]
archivedAt
integer
inputFieldDependencies
(SINGLE_FIELD · object | CONDITIONAL_SINGLE_FIELD · object)[]
  • SINGLE_FIELD
  • CONDITIONAL_SINGLE_FIELD
executionRules
object[]
objectRequestOptions
object