--- title: "POST /automation/actions/2026-09/{appId}" method: POST path: "/automation/actions/2026-09/{appId}" tags: ["Basic"] --- # POST /automation/actions/2026-09/{appId} `POST /automation/actions/2026-09/{appId}` ## Path parameters - `appId` integer, required ## Request body - PublicActionDefinitionEgg - `actionUrl` string, required - `archivedAt` integer - `executionRules` PublicExecutionTranslationRule[] - `conditions` object, required - `labelName` string, required - `functions` PublicActionFunction[], required - `functionSource` string, required - `functionType` 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', required - `id` string - `inputFieldDependencies` union[] - union - PublicSingleFieldDependency - `controllingFieldName` string, required - `dependencyType` 'SINGLE_FIELD', required - `dependentFieldNames` string[], required - PublicConditionalSingleFieldDependency - `controllingFieldName` string, required - `controllingFieldValue` string, required - `dependencyType` 'CONDITIONAL_SINGLE_FIELD', required - `dependentFieldNames` string[], required - `inputFields` PublicInputFieldDefinition[], required - `isRequired` boolean, required - `supportedValueTypes` string[] - `typeDefinition` PublicFieldTypeDefinition, required - `description` string - `fieldType` 'booleancheckbox' | 'calculation_equation' | 'checkbox' | 'date' | 'file' | 'html' | 'number' | 'phonenumber' | 'radio' | 'select' | 'text' | 'textarea' - `helpText` string - `label` string - `name` string, required - `options` PublicOption[], required - `description` string - `displayOrder` integer - `label` string, required - `value` string, required - `optionsUrl` string - `referencedObjectType` 'OWNER' - `type` 'bool' | 'date' | 'datetime' | 'enumeration' | 'json' | 'number' | 'object_coordinates' | 'phone_number' | 'string', required - `labels` object, required - `objectRequestOptions` PublicObjectRequestOptions - `properties` string[], required - `objectTypes` string[], required - `outputFields` OutputFieldDefinition[] - `typeDefinition` FieldTypeDefinition, required - `description` string - `externalOptions` boolean, required - `externalOptionsReferenceType` string - `fieldType` 'booleancheckbox' | 'calculation_equation' | 'calculation_read_time' | 'calculation_rollup' | 'calculation_score' | 'checkbox' | 'date' | 'file' | 'html' | 'number' | 'phonenumber' | 'radio' | 'select' | 'text' | 'textarea' | 'unknown' - `helpText` string - `label` string - `name` string, required - `options` Option[], required - `description` string, required — A description of the option. - `displayOrder` integer, required — The position of the item relative to others in the list. - `doubleData` number, required - `hidden` boolean, required — Whether the option is displayed in HubSpot's UI. - `label` string, required — A user-friendly label that identifies the option. - `readOnly` boolean, required — Whether the option is read-only. - `value` string, required — The actual value of the option. - `optionsUrl` string - `referencedObjectType` 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE' - `schema` union, required - IntegerFieldSchema - `maximum` integer - `minimum` integer - `type` 'INTEGER', required - LongFieldSchema - `maximum` integer - `minimum` integer - `type` 'LONG', required - DoubleFieldSchema - `maximum` number - `minimum` number - `type` 'DOUBLE', required - StringFieldSchema - `format` 'DATE' | 'DATE_TIME' | 'OBJECT_COORDINATE' | 'TIME' | 'URI' - `type` 'STRING', required - BooleanFieldSchema - `type` 'BOOLEAN', required - ArrayFieldSchema - `items` union, required - IntegerFieldSchema - … - LongFieldSchema - … - DoubleFieldSchema - … - StringFieldSchema - … - BooleanFieldSchema - … - ArrayFieldSchema — recursive - ObjectFieldSchema - … - `type` 'ARRAY', required - ObjectFieldSchema - `properties` object, required - `type` 'OBJECT', required - `type` 'bool' | 'currency_number' | 'date' | 'datetime' | 'enumeration' | 'json' | 'number' | 'object_coordinates' | 'phone_number' | 'string', required - `useChirp` boolean, required - `published` boolean, required ## Response `201` successful operation - PublicActionDefinition - `actionUrl` string, required - `archivedAt` integer - `executionRules` PublicExecutionTranslationRule[] - `conditions` object, required - `labelName` string, required - `functions` PublicActionFunctionIdentifier[], required - `functionType` 'POST_ACTION_EXECUTION' | 'POST_FETCH_OPTIONS' | 'PRE_ACTION_EXECUTION' | 'PRE_FETCH_OPTIONS', required - `id` string - `id` string, required - `inputFieldDependencies` union[] - union - PublicSingleFieldDependency - `controllingFieldName` string, required - `dependencyType` 'SINGLE_FIELD', required - `dependentFieldNames` string[], required - PublicConditionalSingleFieldDependency - `controllingFieldName` string, required - `controllingFieldValue` string, required - `dependencyType` 'CONDITIONAL_SINGLE_FIELD', required - `dependentFieldNames` string[], required - `inputFields` PublicInputFieldDefinition[], required - `isRequired` boolean, required - `supportedValueTypes` string[] - `typeDefinition` PublicFieldTypeDefinition, required - `description` string - `fieldType` 'booleancheckbox' | 'calculation_equation' | 'checkbox' | 'date' | 'file' | 'html' | 'number' | 'phonenumber' | 'radio' | 'select' | 'text' | 'textarea' - `helpText` string - `label` string - `name` string, required - `options` PublicOption[], required - `description` string - `displayOrder` integer - `label` string, required - `value` string, required - `optionsUrl` string - `referencedObjectType` 'OWNER' - `type` 'bool' | 'date' | 'datetime' | 'enumeration' | 'json' | 'number' | 'object_coordinates' | 'phone_number' | 'string', required - `labels` object, required - `objectRequestOptions` PublicObjectRequestOptions - `properties` string[], required - `objectTypes` string[], required - `outputFields` OutputFieldDefinition[] - `typeDefinition` FieldTypeDefinition, required - `description` string - `externalOptions` boolean, required - `externalOptionsReferenceType` string - `fieldType` 'booleancheckbox' | 'calculation_equation' | 'calculation_read_time' | 'calculation_rollup' | 'calculation_score' | 'checkbox' | 'date' | 'file' | 'html' | 'number' | 'phonenumber' | 'radio' | 'select' | 'text' | 'textarea' | 'unknown' - `helpText` string - `label` string - `name` string, required - `options` Option[], required - `description` string, required — A description of the option. - `displayOrder` integer, required — The position of the item relative to others in the list. - `doubleData` number, required - `hidden` boolean, required — Whether the option is displayed in HubSpot's UI. - `label` string, required — A user-friendly label that identifies the option. - `readOnly` boolean, required — Whether the option is read-only. - `value` string, required — The actual value of the option. - `optionsUrl` string - `referencedObjectType` 'ABANDONED_CART' | 'ACCEPTANCE_TEST' | 'AD' | 'AD_ACCOUNT' | 'AD_CAMPAIGN' | 'AD_GROUP' | 'AI_FORECAST' | 'ALL_PAGES' | 'APPROVAL' | 'APPROVAL_STEP' | 'ATTRIBUTION' | 'AUDIENCE' | 'AUTOMATION_JOURNEY' | 'AUTOMATION_PLATFORM_FLOW' | 'AUTOMATION_PLATFORM_FLOW_ACTION' | 'BET_ALERT' | 'BET_DELIVERABLE_SERVICE' | 'BLOG_LISTING_PAGE' | 'BLOG_POST' | 'CALL' | 'CAMPAIGN' | 'CAMPAIGN_BUDGET_ITEM' | 'CAMPAIGN_SPEND_ITEM' | 'CAMPAIGN_STEP' | 'CAMPAIGN_TEMPLATE' | 'CAMPAIGN_TEMPLATE_STEP' | 'CART' | 'CASE_STUDY' | 'CHATFLOW' | 'CLIP' | 'CMS_URL' | 'COMBO_EVENT_CONFIGURATION' | 'COMMERCE_PAYMENT' | 'COMMUNICATION' | 'COMPANY' | 'CONTACT' | 'CONTACT_CREATE_ATTRIBUTION' | 'CONTENT' | 'CONTENT_AUDIT' | 'CONTENT_AUDIT_PAGE' | 'CONVERSATION' | 'CONVERSATION_INBOX' | 'CONVERSATION_SESSION' | 'CRM_OBJECTS_DUMMY_TYPE' | 'CRM_PIPELINES_DUMMY_TYPE' | 'CTA' | 'CTA_VARIANT' | 'DATA_PRIVACY_CONSENT' | 'DATA_SYNC_STATE' | 'DEAL' | 'DEAL_CREATE_ATTRIBUTION' | 'DEAL_REGISTRATION' | 'DEAL_SPLIT' | 'DISCOUNT' | 'DISCOUNT_CODE' | 'DISCOUNT_TEMPLATE' | 'EMAIL' | 'ENGAGEMENT' | 'EXPORT' | 'EXTERNAL_WEB_URL' | 'FEE' | 'FEEDBACK_SUBMISSION' | 'FEEDBACK_SURVEY' | 'FILE_MANAGER_FILE' | 'FILE_MANAGER_FOLDER' | 'FOLDER' | 'FORECAST' | 'FORM' | 'FORM_SUBMISSION_INBOUNDDB' | 'GOAL_TARGET' | 'GOAL_TARGET_GROUP' | 'GOAL_TEMPLATE' | 'GSC_PROPERTY' | 'HUB' | 'IMPORT' | 'INVOICE' | 'KEYWORD' | 'KNOWLEDGE_ARTICLE' | 'LANDING_PAGE' | 'LEAD' | 'LINE_ITEM' | 'MARKETING_CALENDAR' | 'MARKETING_CAMPAIGN_UTM' | 'MARKETING_EMAIL' | 'MARKETING_EVENT' | 'MARKETING_EVENT_ATTENDANCE' | 'MARKETING_SMS' | 'MEDIA_BRIDGE' | 'MEETING_EVENT' | 'MIC' | 'NOTE' | 'OBJECT_LIST' | 'ORDER' | 'OWNER' | 'PARTNER_ACCOUNT' | 'PARTNER_CLIENT' | 'PARTNER_CLIENT_REVENUE' | 'PARTNER_SERVICE' | 'PAYMENT_LINK' | 'PAYMENT_SCHEDULE' | 'PAYMENT_SCHEDULE_INSTALLMENT' | 'PERMISSIONS_TESTING' | 'PLAYBOOK' | 'PLAYBOOK_QUESTION' | 'PLAYBOOK_SUBMISSION' | 'PLAYBOOK_SUBMISSION_ANSWER' | 'PLAYLIST' | 'PLAYLIST_FOLDER' | 'PODCAST_EPISODE' | 'PORTAL' | 'PORTAL_OBJECT_SYNC_MESSAGE' | 'POSTAL_MAIL' | 'PRIVACY_SCANNER_COOKIE' | 'PRODUCT' | 'PRODUCT_OR_FOLDER' | 'PROPERTY_INFO' | 'PROSPECTING_AGENT_CONTACT_ASSIGNMENT' | 'PUBLISHING_TASK' | 'QUARANTINED_SUBMISSION' | 'QUOTA' | 'QUOTE' | 'QUOTE_FIELD' | 'QUOTE_MODULE' | 'QUOTE_MODULE_FIELD' | 'QUOTE_TEMPLATE' | 'RESTORABLE_CRM_OBJECT' | 'ROSTER' | 'ROSTER_MEMBER' | 'SALES_DOCUMENT' | 'SALES_TASK' | 'SALES_WORKLOAD' | 'SALESFORCE_SYNC_ERROR' | 'SCHEDULING_PAGE' | 'SCHEMAS_BACKEND_TEST' | 'SCORE_CONFIGURATION' | 'SEQUENCE' | 'SEQUENCE_ENROLLMENT' | 'SEQUENCE_STEP' | 'SEQUENCE_STEP_ENROLLMENT' | 'SERVICE' | 'SITE_PAGE' | 'SNIPPET' | 'SOCIAL_BROADCAST' | 'SOCIAL_CHANNEL' | 'SOCIAL_POST' | 'SOCIAL_PROFILE' | 'SOX_PROTECTED_DUMMY_TYPE' | 'SOX_PROTECTED_TEST_TYPE' | 'SUBMISSION_TAG' | 'SUBSCRIPTION' | 'TASK' | 'TASK_TEMPLATE' | 'TAX' | 'TEMPLATE' | 'TICKET' | 'UNKNOWN' | 'UNSUBSCRIBE' | 'USER' | 'VIEW' | 'VIEW_BLOCK' | 'WEB_INTERACTIVE' - `schema` union, required - IntegerFieldSchema - `maximum` integer - `minimum` integer - `type` 'INTEGER', required - LongFieldSchema - `maximum` integer - `minimum` integer - `type` 'LONG', required - DoubleFieldSchema - `maximum` number - `minimum` number - `type` 'DOUBLE', required - StringFieldSchema - `format` 'DATE' | 'DATE_TIME' | 'OBJECT_COORDINATE' | 'TIME' | 'URI' - `type` 'STRING', required - BooleanFieldSchema - `type` 'BOOLEAN', required - ArrayFieldSchema - `items` union, required - IntegerFieldSchema - … - LongFieldSchema - … - DoubleFieldSchema - … - StringFieldSchema - … - BooleanFieldSchema - … - ArrayFieldSchema — recursive - ObjectFieldSchema - … - `type` 'ARRAY', required - ObjectFieldSchema - `properties` object, required - `type` 'OBJECT', required - `type` 'bool' | 'currency_number' | 'date' | 'datetime' | 'enumeration' | 'json' | 'number' | 'object_coordinates' | 'phone_number' | 'string', required - `useChirp` boolean, required - `published` boolean, required - `revisionId` string, required ## Other responses - `default` — An error occurred. --- [API](https://skmtc.net/hubspot/apis/automation-actions-v4.md) · [All operations](https://skmtc.net/hubspot/apis/automation-actions-v4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/automation-actions-v4/revisions/996d692117a4/schema)