PATCH
/
automation
/
v4
/
actions
/
{appId}
/
{definitionId}
Update an existing action definition
curl --request PATCH \
  --url https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId} \
  --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
      }
    }
  ],
  "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>"
    ]
  }
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubFree

Authorizations

​
hapikey
string
query
required

Path Parameters

​
definitionId
string
required

The ID of the custom action definition.

​
appId
integer
required

The ID of the app.

Body

application/json

Response

200
application/json

successful operation

The response is of type object.