Zum Hauptinhalt springen
POST
/
automation
/
v4
/
flows
Neuen Workflow erstellen
curl --request POST \
  --url https://api.hubapi.com/automation/v4/flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "type": "CONTACT_FLOW",
  "objectTypeId": "<string>",
  "canEnrollFromSalesforce": true,
  "isEnabled": true,
  "flowType": "WORKFLOW",
  "name": "<string>",
  "description": "<string>",
  "uuid": "<string>",
  "startActionId": "<string>",
  "actions": [
    {
      "staticBranches": [
        {
          "branchValue": "some_value",
          "connection": {}
        }
      ],
      "defaultBranchName": "Other",
      "defaultBranch": {
        "nextActionId": "<string>",
        "edgeType": "<string>"
      },
      "inputValue": "{ \"type\": \"STATIC_VALUE\", \"staticValue\": \"test_value\" }",
      "actionId": "1",
      "type": "STATIC_BRANCH"
    }
  ],
  "enrollmentCriteria": {
    "listFilterBranch": {
      "filterBranchType": "OR",
      "filterBranches": [
        "<any>"
      ],
      "filterBranchOperator": "<string>",
      "filters": [
        "<any>"
      ]
    },
    "reEnrollmentTriggersFilterBranches": [
      {
        "filterBranchType": "OR",
        "filterBranches": [
          "<any>"
        ],
        "filterBranchOperator": "<string>",
        "filters": [
          "<any>"
        ]
      }
    ],
    "unEnrollObjectsNotMeetingCriteria": false,
    "shouldReEnroll": false,
    "type": "\"LIST_BASED\""
  },
  "enrollmentSchedule": {
    "type": "DAILY",
    "timeOfDay": {
      "hour": 123,
      "minute": 123
    }
  },
  "timeWindows": [
    {
      "startTime": {
        "hour": 123,
        "minute": 123
      },
      "endTime": {
        "hour": 123,
        "minute": 123
      },
      "day": "MONDAY"
    }
  ],
  "blockedDates": [
    {
      "month": "JANUARY",
      "year": 123,
      "dayOfMonth": 123
    }
  ],
  "customProperties": {},
  "dataSources": [
    {
      "objectTypeId": "<string>",
      "name": "<string>",
      "associationTypeId": 123,
      "associationCategory": "HUBSPOT_DEFINED",
      "sortBy": {
        "property": "<string>",
        "missing": "<string>",
        "order": "ASC"
      },
      "type": "ASSOCIATION"
    }
  ],
  "suppressionListIds": [
    123
  ],
  "goalFilterBranch": {
    "filterBranchType": "OR",
    "filterBranches": [
      "<any>"
    ],
    "filterBranchOperator": "<string>",
    "filters": [
      "<any>"
    ]
  },
  "eventAnchor": {
    "type": "CONTACT_PROPERTY_ANCHOR",
    "contactProperty": "example_date_property"
  },
  "unEnrollmentSetting": {
    "flowIds": [
      "<string>"
    ],
    "type": "ALL"
  }
}'
{
  "type": "CONTACT_FLOW",
  "id": "<string>",
  "isEnabled": true,
  "flowType": "WORKFLOW",
  "revisionId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "uuid": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startActionId": "<string>",
  "nextAvailableActionId": "<string>",
  "actions": [
    {
      "staticBranches": [
        {
          "branchValue": "some_value",
          "connection": {}
        }
      ],
      "defaultBranchName": "Other",
      "defaultBranch": {
        "nextActionId": "<string>",
        "edgeType": "<string>"
      },
      "inputValue": "{ \"type\": \"STATIC_VALUE\", \"staticValue\": \"test_value\" }",
      "actionId": "1",
      "type": "STATIC_BRANCH"
    }
  ],
  "enrollmentCriteria": {
    "listFilterBranch": {
      "filterBranchType": "OR",
      "filterBranches": [
        "<any>"
      ],
      "filterBranchOperator": "<string>",
      "filters": [
        "<any>"
      ]
    },
    "reEnrollmentTriggersFilterBranches": [
      {
        "filterBranchType": "OR",
        "filterBranches": [
          "<any>"
        ],
        "filterBranchOperator": "<string>",
        "filters": [
          "<any>"
        ]
      }
    ],
    "unEnrollObjectsNotMeetingCriteria": false,
    "shouldReEnroll": false,
    "type": "\"LIST_BASED\""
  },
  "enrollmentSchedule": {
    "type": "DAILY",
    "timeOfDay": {
      "hour": 123,
      "minute": 123
    }
  },
  "timeWindows": [
    {
      "startTime": {
        "hour": 123,
        "minute": 123
      },
      "endTime": {
        "hour": 123,
        "minute": 123
      },
      "day": "MONDAY"
    }
  ],
  "blockedDates": [
    {
      "month": "JANUARY",
      "year": 123,
      "dayOfMonth": 123
    }
  ],
  "customProperties": {},
  "dataSources": [
    {
      "objectTypeId": "<string>",
      "name": "<string>",
      "associationTypeId": 123,
      "associationCategory": "HUBSPOT_DEFINED",
      "sortBy": {
        "property": "<string>",
        "missing": "<string>",
        "order": "ASC"
      },
      "type": "ASSOCIATION"
    }
  ],
  "crmObjectCreationStatus": "PENDING",
  "suppressionListIds": [
    123
  ],
  "goalFilterBranch": {
    "filterBranchType": "OR",
    "filterBranches": [
      "<any>"
    ],
    "filterBranchOperator": "<string>",
    "filters": [
      "<any>"
    ]
  },
  "canEnrollFromSalesforce": true,
  "eventAnchor": {
    "type": "CONTACT_PROPERTY_ANCHOR",
    "contactProperty": "example_date_property"
  },
  "unEnrollmentSetting": {
    "flowIds": [
      "<string>"
    ],
    "type": "ALL"
  },
  "objectTypeId": "<string>"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos
Diese API erfordert einen der folgenden Bereiche:
automation

Authorizations

​
Authorization
string
header
required

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

Body

application/json
  • Option 1
  • Option 2
​
type
enum<string>
default:CONTACT_FLOW
required
Available options:
CONTACT_FLOW,
PLATFORM_FLOW
​
objectTypeId
string
required
​
canEnrollFromSalesforce
boolean
required
​
isEnabled
boolean
required
​
flowType
enum<string>
required
Available options:
WORKFLOW,
ACTION_SET,
UNKNOWN
​
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
required
  • STATIC_BRANCH
  • LIST_BRANCH
  • AB_TEST_BRANCH
  • CUSTOM_CODE
  • WEBHOOK
  • SINGLE_CONNECTION
​
timeWindows
object[]
required
​
blockedDates
object[]
required
​
customProperties
object
required
​
dataSources
(ASSOCIATION · object | ASSOCIATION_TIMESTAMP · object | STATIC_PROPERTY_FILTER · object | ENROLLED_RECORD_PROPERTY_FILTER · object | DATASET_FIELD_PROPERTY_FILTER · object | ENROLLED_ARGUMENT_PROPERTY_FILTER · object)[]
required
  • ASSOCIATION
  • ASSOCIATION_TIMESTAMP
  • STATIC_PROPERTY_FILTER
  • ENROLLED_RECORD_PROPERTY_FILTER
  • DATASET_FIELD_PROPERTY_FILTER
  • ENROLLED_ARGUMENT_PROPERTY_FILTER
​
suppressionListIds
integer[]
required
​
name
string
​
description
string
​
uuid
string
​
startActionId
string
​
enrollmentCriteria
object
  • LIST_BASED
  • EVENT_BASED
  • MANUAL
​
enrollmentSchedule
object
  • DAILY
  • WEEKLY
  • MONTHLY_SPECIFIC_DAYS
  • MONTHLY_RELATIVE_DAYS
  • YEARLY
  • PROPERTY_BASED
​
goalFilterBranch
object
  • OR
  • AND
  • NOT_ALL
  • NOT_ANY
  • RESTRICTED
  • UNIFIED_EVENTS
  • PROPERTY_ASSOCIATION
  • ASSOCIATION
​
eventAnchor
object
  • CONTACT_PROPERTY_ANCHOR
  • STATIC_DATE_ANCHOR
​
unEnrollmentSetting
object

Response

successful operation

  • Option 1
  • Option 2
​
type
enum<string>
default:CONTACT_FLOW
required
Available options:
CONTACT_FLOW,
PLATFORM_FLOW
​
id
string
required
​
isEnabled
boolean
required
​
flowType
enum<string>
required
Available options:
WORKFLOW,
ACTION_SET,
UNKNOWN
​
revisionId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
nextAvailableActionId
string
required
​
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
required
  • STATIC_BRANCH
  • LIST_BRANCH
  • AB_TEST_BRANCH
  • CUSTOM_CODE
  • WEBHOOK
  • SINGLE_CONNECTION
​
timeWindows
object[]
required
​
blockedDates
object[]
required
​
customProperties
object
required
​
dataSources
(ASSOCIATION · object | ASSOCIATION_TIMESTAMP · object | STATIC_PROPERTY_FILTER · object | ENROLLED_RECORD_PROPERTY_FILTER · object | DATASET_FIELD_PROPERTY_FILTER · object | ENROLLED_ARGUMENT_PROPERTY_FILTER · object)[]
required
  • ASSOCIATION
  • ASSOCIATION_TIMESTAMP
  • STATIC_PROPERTY_FILTER
  • ENROLLED_RECORD_PROPERTY_FILTER
  • DATASET_FIELD_PROPERTY_FILTER
  • ENROLLED_ARGUMENT_PROPERTY_FILTER
​
crmObjectCreationStatus
enum<string>
required
Available options:
PENDING,
COMPLETE
​
suppressionListIds
integer[]
required
​
canEnrollFromSalesforce
boolean
required
​
objectTypeId
string
required
​
name
string
​
description
string
​
uuid
string
​
startActionId
string
​
enrollmentCriteria
object
  • LIST_BASED
  • EVENT_BASED
  • MANUAL
​
enrollmentSchedule
object
  • DAILY
  • WEEKLY
  • MONTHLY_SPECIFIC_DAYS
  • MONTHLY_RELATIVE_DAYS
  • YEARLY
  • PROPERTY_BASED
​
goalFilterBranch
object
  • OR
  • AND
  • NOT_ALL
  • NOT_ANY
  • RESTRICTED
  • UNIFIED_EVENTS
  • PROPERTY_ASSOCIATION
  • ASSOCIATION
​
eventAnchor
object
  • CONTACT_PROPERTY_ANCHOR
  • STATIC_DATE_ANCHOR
​
unEnrollmentSetting
object
⌘I