ワークフローを作成
curl --request POST \
--url https://api.hubapi.com/automation/v4/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [
{
"branchValue": "<string>"
}
],
"type": "STATIC_BRANCH",
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": true,
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION"
}
],
"isEnabled": true,
"objectTypeId": "<string>",
"suppressionListIds": [
123
],
"timeWindows": [
{}
],
"type": "CONTACT_FLOW",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": true,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": true
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"uuid": "<string>"
}
'import requests
url = "https://api.hubapi.com/automation/v4/flows"
payload = {
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [{ "branchValue": "<string>" }],
"type": "STATIC_BRANCH",
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": True,
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION"
}
],
"isEnabled": True,
"objectTypeId": "<string>",
"suppressionListIds": [123],
"timeWindows": [{}],
"type": "CONTACT_FLOW",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": True,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": True
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"uuid": "<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({
actions: [
{
actionId: '<string>',
inputValue: {actionId: '<string>', dataKey: '<string>', type: 'FIELD_DATA'},
staticBranches: [{branchValue: '<string>'}],
type: 'STATIC_BRANCH',
defaultBranchName: '<string>'
}
],
blockedDates: [{dayOfMonth: 123, year: 123}],
canEnrollFromSalesforce: true,
customProperties: {},
dataSources: [
{
associationTypeId: 123,
name: '<string>',
objectTypeId: '<string>',
type: 'ASSOCIATION'
}
],
isEnabled: true,
objectTypeId: '<string>',
suppressionListIds: [123],
timeWindows: [{}],
type: 'CONTACT_FLOW',
description: '<string>',
enrollmentCriteria: {
listFilterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
},
reEnrollmentTriggersFilterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
shouldReEnroll: true,
type: 'LIST_BASED',
unEnrollObjectsNotMeetingCriteria: true
},
enrollmentSchedule: {timeOfDay: {hour: 123, minute: 123}, type: 'DAILY'},
eventAnchor: {contactProperty: '<string>', type: 'CONTACT_PROPERTY_ANCHOR'},
goalFilterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
},
name: '<string>',
startActionId: '<string>',
uuid: '<string>'
})
};
fetch('https://api.hubapi.com/automation/v4/flows', 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/flows",
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([
'actions' => [
[
'actionId' => '<string>',
'inputValue' => [
'actionId' => '<string>',
'dataKey' => '<string>',
'type' => 'FIELD_DATA'
],
'staticBranches' => [
[
'branchValue' => '<string>'
]
],
'type' => 'STATIC_BRANCH',
'defaultBranchName' => '<string>'
]
],
'blockedDates' => [
[
'dayOfMonth' => 123,
'year' => 123
]
],
'canEnrollFromSalesforce' => true,
'customProperties' => [
],
'dataSources' => [
[
'associationTypeId' => 123,
'name' => '<string>',
'objectTypeId' => '<string>',
'type' => 'ASSOCIATION'
]
],
'isEnabled' => true,
'objectTypeId' => '<string>',
'suppressionListIds' => [
123
],
'timeWindows' => [
[
]
],
'type' => 'CONTACT_FLOW',
'description' => '<string>',
'enrollmentCriteria' => [
'listFilterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
],
'reEnrollmentTriggersFilterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'shouldReEnroll' => true,
'type' => 'LIST_BASED',
'unEnrollObjectsNotMeetingCriteria' => true
],
'enrollmentSchedule' => [
'timeOfDay' => [
'hour' => 123,
'minute' => 123
],
'type' => 'DAILY'
],
'eventAnchor' => [
'contactProperty' => '<string>',
'type' => 'CONTACT_PROPERTY_ANCHOR'
],
'goalFilterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
],
'name' => '<string>',
'startActionId' => '<string>',
'uuid' => '<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/flows"
payload := strings.NewReader("{\n \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\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/flows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/automation/v4/flows")
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 \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [
{
"branchValue": "<string>",
"connection": {
"nextActionId": "<string>"
}
}
],
"type": "STATIC_BRANCH",
"defaultBranch": {
"nextActionId": "<string>"
},
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": true,
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION",
"sortBy": {
"property": "<string>",
"missing": "<string>"
}
}
],
"id": "<string>",
"isEnabled": true,
"nextAvailableActionId": "<string>",
"objectTypeId": "<string>",
"revisionId": "<string>",
"suppressionListIds": [
123
],
"timeWindows": [
{
"endTime": {
"hour": 123,
"minute": 123
},
"startTime": {
"hour": 123,
"minute": 123
}
}
],
"type": "CONTACT_FLOW",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": true,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": true
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"unEnrollmentSetting": {
"flowIds": [
"<string>"
]
},
"uuid": "<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"
}
}ワークフロー
Create a workflow
リクエスト本文で必要な詳細を指定して、新しい自動化フローを作成します。
POST
/
automation
/
v4
/
flows
ワークフローを作成
curl --request POST \
--url https://api.hubapi.com/automation/v4/flows \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [
{
"branchValue": "<string>"
}
],
"type": "STATIC_BRANCH",
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": true,
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION"
}
],
"isEnabled": true,
"objectTypeId": "<string>",
"suppressionListIds": [
123
],
"timeWindows": [
{}
],
"type": "CONTACT_FLOW",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": true,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": true
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"uuid": "<string>"
}
'import requests
url = "https://api.hubapi.com/automation/v4/flows"
payload = {
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [{ "branchValue": "<string>" }],
"type": "STATIC_BRANCH",
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": True,
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION"
}
],
"isEnabled": True,
"objectTypeId": "<string>",
"suppressionListIds": [123],
"timeWindows": [{}],
"type": "CONTACT_FLOW",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": True,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": True
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": True,
"operationType": "BOOL",
"operator": "<string>",
"value": True
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"uuid": "<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({
actions: [
{
actionId: '<string>',
inputValue: {actionId: '<string>', dataKey: '<string>', type: 'FIELD_DATA'},
staticBranches: [{branchValue: '<string>'}],
type: 'STATIC_BRANCH',
defaultBranchName: '<string>'
}
],
blockedDates: [{dayOfMonth: 123, year: 123}],
canEnrollFromSalesforce: true,
customProperties: {},
dataSources: [
{
associationTypeId: 123,
name: '<string>',
objectTypeId: '<string>',
type: 'ASSOCIATION'
}
],
isEnabled: true,
objectTypeId: '<string>',
suppressionListIds: [123],
timeWindows: [{}],
type: 'CONTACT_FLOW',
description: '<string>',
enrollmentCriteria: {
listFilterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
},
reEnrollmentTriggersFilterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
shouldReEnroll: true,
type: 'LIST_BASED',
unEnrollObjectsNotMeetingCriteria: true
},
enrollmentSchedule: {timeOfDay: {hour: 123, minute: 123}, type: 'DAILY'},
eventAnchor: {contactProperty: '<string>', type: 'CONTACT_PROPERTY_ANCHOR'},
goalFilterBranch: {
filterBranchOperator: '<string>',
filterBranchType: 'OR',
filterBranches: [
{
filterBranchOperator: '<string>',
filterBranchType: 'AND',
filterBranches: '<array>',
filters: [{filterType: 'PROPERTY', operation: '<unknown>', property: '<string>'}]
}
],
filters: [
{
filterType: 'PROPERTY',
operation: {
includeObjectsWithNoValueSet: true,
operationType: 'BOOL',
operator: '<string>',
value: true
},
property: '<string>'
}
]
},
name: '<string>',
startActionId: '<string>',
uuid: '<string>'
})
};
fetch('https://api.hubapi.com/automation/v4/flows', 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/flows",
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([
'actions' => [
[
'actionId' => '<string>',
'inputValue' => [
'actionId' => '<string>',
'dataKey' => '<string>',
'type' => 'FIELD_DATA'
],
'staticBranches' => [
[
'branchValue' => '<string>'
]
],
'type' => 'STATIC_BRANCH',
'defaultBranchName' => '<string>'
]
],
'blockedDates' => [
[
'dayOfMonth' => 123,
'year' => 123
]
],
'canEnrollFromSalesforce' => true,
'customProperties' => [
],
'dataSources' => [
[
'associationTypeId' => 123,
'name' => '<string>',
'objectTypeId' => '<string>',
'type' => 'ASSOCIATION'
]
],
'isEnabled' => true,
'objectTypeId' => '<string>',
'suppressionListIds' => [
123
],
'timeWindows' => [
[
]
],
'type' => 'CONTACT_FLOW',
'description' => '<string>',
'enrollmentCriteria' => [
'listFilterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
],
'reEnrollmentTriggersFilterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'shouldReEnroll' => true,
'type' => 'LIST_BASED',
'unEnrollObjectsNotMeetingCriteria' => true
],
'enrollmentSchedule' => [
'timeOfDay' => [
'hour' => 123,
'minute' => 123
],
'type' => 'DAILY'
],
'eventAnchor' => [
'contactProperty' => '<string>',
'type' => 'CONTACT_PROPERTY_ANCHOR'
],
'goalFilterBranch' => [
'filterBranchOperator' => '<string>',
'filterBranchType' => 'OR',
'filterBranches' => [
[
'filterBranchOperator' => '<string>',
'filterBranchType' => 'AND',
'filterBranches' => '<array>',
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => '<unknown>',
'property' => '<string>'
]
]
]
],
'filters' => [
[
'filterType' => 'PROPERTY',
'operation' => [
'includeObjectsWithNoValueSet' => true,
'operationType' => 'BOOL',
'operator' => '<string>',
'value' => true
],
'property' => '<string>'
]
]
],
'name' => '<string>',
'startActionId' => '<string>',
'uuid' => '<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/flows"
payload := strings.NewReader("{\n \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\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/flows")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/automation/v4/flows")
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 \"actions\": [\n {\n \"actionId\": \"<string>\",\n \"inputValue\": {\n \"actionId\": \"<string>\",\n \"dataKey\": \"<string>\",\n \"type\": \"FIELD_DATA\"\n },\n \"staticBranches\": [\n {\n \"branchValue\": \"<string>\"\n }\n ],\n \"type\": \"STATIC_BRANCH\",\n \"defaultBranchName\": \"<string>\"\n }\n ],\n \"blockedDates\": [\n {\n \"dayOfMonth\": 123,\n \"year\": 123\n }\n ],\n \"canEnrollFromSalesforce\": true,\n \"customProperties\": {},\n \"dataSources\": [\n {\n \"associationTypeId\": 123,\n \"name\": \"<string>\",\n \"objectTypeId\": \"<string>\",\n \"type\": \"ASSOCIATION\"\n }\n ],\n \"isEnabled\": true,\n \"objectTypeId\": \"<string>\",\n \"suppressionListIds\": [\n 123\n ],\n \"timeWindows\": [\n {}\n ],\n \"type\": \"CONTACT_FLOW\",\n \"description\": \"<string>\",\n \"enrollmentCriteria\": {\n \"listFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n },\n \"reEnrollmentTriggersFilterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"shouldReEnroll\": true,\n \"type\": \"LIST_BASED\",\n \"unEnrollObjectsNotMeetingCriteria\": true\n },\n \"enrollmentSchedule\": {\n \"timeOfDay\": {\n \"hour\": 123,\n \"minute\": 123\n },\n \"type\": \"DAILY\"\n },\n \"eventAnchor\": {\n \"contactProperty\": \"<string>\",\n \"type\": \"CONTACT_PROPERTY_ANCHOR\"\n },\n \"goalFilterBranch\": {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"OR\",\n \"filterBranches\": [\n {\n \"filterBranchOperator\": \"<string>\",\n \"filterBranchType\": \"AND\",\n \"filterBranches\": \"<array>\",\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": \"<unknown>\",\n \"property\": \"<string>\"\n }\n ]\n }\n ],\n \"filters\": [\n {\n \"filterType\": \"PROPERTY\",\n \"operation\": {\n \"includeObjectsWithNoValueSet\": true,\n \"operationType\": \"BOOL\",\n \"operator\": \"<string>\",\n \"value\": true\n },\n \"property\": \"<string>\"\n }\n ]\n },\n \"name\": \"<string>\",\n \"startActionId\": \"<string>\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"actions": [
{
"actionId": "<string>",
"inputValue": {
"actionId": "<string>",
"dataKey": "<string>",
"type": "FIELD_DATA"
},
"staticBranches": [
{
"branchValue": "<string>",
"connection": {
"nextActionId": "<string>"
}
}
],
"type": "STATIC_BRANCH",
"defaultBranch": {
"nextActionId": "<string>"
},
"defaultBranchName": "<string>"
}
],
"blockedDates": [
{
"dayOfMonth": 123,
"year": 123
}
],
"canEnrollFromSalesforce": true,
"createdAt": "2023-11-07T05:31:56Z",
"customProperties": {},
"dataSources": [
{
"associationTypeId": 123,
"name": "<string>",
"objectTypeId": "<string>",
"type": "ASSOCIATION",
"sortBy": {
"property": "<string>",
"missing": "<string>"
}
}
],
"id": "<string>",
"isEnabled": true,
"nextAvailableActionId": "<string>",
"objectTypeId": "<string>",
"revisionId": "<string>",
"suppressionListIds": [
123
],
"timeWindows": [
{
"endTime": {
"hour": 123,
"minute": 123
},
"startTime": {
"hour": 123,
"minute": 123
}
}
],
"type": "CONTACT_FLOW",
"updatedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"enrollmentCriteria": {
"listFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
},
"reEnrollmentTriggersFilterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"shouldReEnroll": true,
"type": "LIST_BASED",
"unEnrollObjectsNotMeetingCriteria": true
},
"enrollmentSchedule": {
"timeOfDay": {
"hour": 123,
"minute": 123
},
"type": "DAILY"
},
"eventAnchor": {
"contactProperty": "<string>",
"type": "CONTACT_PROPERTY_ANCHOR"
},
"goalFilterBranch": {
"filterBranchOperator": "<string>",
"filterBranchType": "OR",
"filterBranches": [
{
"filterBranchOperator": "<string>",
"filterBranchType": "AND",
"filterBranches": "<array>",
"filters": [
{
"filterType": "PROPERTY",
"operation": "<unknown>",
"property": "<string>"
}
]
}
],
"filters": [
{
"filterType": "PROPERTY",
"operation": {
"includeObjectsWithNoValueSet": true,
"operationType": "BOOL",
"operator": "<string>",
"value": true
},
"property": "<string>"
}
]
},
"name": "<string>",
"startActionId": "<string>",
"unEnrollmentSetting": {
"flowIds": [
"<string>"
]
},
"uuid": "<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
Supported products
Required Scopes
Required Scopes
承認
The access token received from the authorization server in the OAuth 2.0 flow.
ボディ
application/json
- Option 1
- Option 2
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
必須
- STATIC_BRANCH
- LIST_BRANCH
- AB_TEST_BRANCH
- CUSTOM_CODE
- WEBHOOK
- SINGLE_CONNECTION
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
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)[]
必須
- ASSOCIATION
- ASSOCIATION_TIMESTAMP
- STATIC_PROPERTY_FILTER
- ENROLLED_RECORD_PROPERTY_FILTER
- DATASET_FIELD_PROPERTY_FILTER
- ENROLLED_ARGUMENT_PROPERTY_FILTER
Show child attributes
Show child attributes
利用可能なオプション:
ACTION_SET, UNKNOWN, WORKFLOW Show child attributes
Show child attributes
利用可能なオプション:
CONTACT_FLOW - LIST_BASED
- EVENT_BASED
- MANUAL
- DATASET
Show child attributes
Show child attributes
- DAILY
- WEEKLY
- MONTHLY_SPECIFIC_DAYS
- MONTHLY_RELATIVE_DAYS
- YEARLY
- PROPERTY_BASED
Show child attributes
Show child attributes
- CONTACT_PROPERTY_ANCHOR
- STATIC_DATE_ANCHOR
Show child attributes
Show child attributes
- OR
- AND
- NOT_ALL
- NOT_ANY
- RESTRICTED
- UNIFIED_EVENTS
- ASSOCIATION
Show child attributes
Show child attributes
Show child attributes
Show child attributes
レスポンス
successful operation
- Option 1
- Option 2
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
必須
- STATIC_BRANCH
- LIST_BRANCH
- AB_TEST_BRANCH
- CUSTOM_CODE
- WEBHOOK
- SINGLE_CONNECTION
Show child attributes
Show child attributes
Show child attributes
Show child attributes
利用可能なオプション:
COMPLETE, PENDING Show child attributes
Show child attributes
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)[]
必須
- ASSOCIATION
- ASSOCIATION_TIMESTAMP
- STATIC_PROPERTY_FILTER
- ENROLLED_RECORD_PROPERTY_FILTER
- DATASET_FIELD_PROPERTY_FILTER
- ENROLLED_ARGUMENT_PROPERTY_FILTER
Show child attributes
Show child attributes
利用可能なオプション:
ACTION_SET, UNKNOWN, WORKFLOW Show child attributes
Show child attributes
利用可能なオプション:
CONTACT_FLOW - LIST_BASED
- EVENT_BASED
- MANUAL
- DATASET
Show child attributes
Show child attributes
- DAILY
- WEEKLY
- MONTHLY_SPECIFIC_DAYS
- MONTHLY_RELATIVE_DAYS
- YEARLY
- PROPERTY_BASED
Show child attributes
Show child attributes
- CONTACT_PROPERTY_ANCHOR
- STATIC_DATE_ANCHOR
Show child attributes
Show child attributes
- OR
- AND
- NOT_ALL
- NOT_ANY
- RESTRICTED
- UNIFIED_EVENTS
- ASSOCIATION
Show child attributes
Show child attributes
Show child attributes
Show child attributes
最終更新日 2026年4月10日
⌘I