HubSpot: Object tags schemas (part 2)
47 HubSpot schemas with complete fields and constraints.
← Object tags operations · All schemas
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fiscalYearStart | string | Optional | A string specifying the start month of the fiscal year. Valid values include 'JANUARY', 'FEBRUARY', 'MARCH', 'APRIL', 'MAY', 'JUNE', 'JULY', 'AUGUST', 'SEPTEMBER', 'OCTOBER', 'NOVEMBER', and 'DECEMBER'. One of: APRIL, AUGUST, DECEMBER, FEBRUARY, JANUARY, JULY, JUNE, MARCH, MAY, NOVEMBER, OCTOBER, SEPTEMBER |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value should be included in the operation. |
operationType | string | Required within parent | A string that specifies the type of operation. The default and only valid value is 'CALENDAR_DATE'. Default: CALENDAR_DATE One of: CALENDAR_DATE |
operator | string | Required within parent | A string representing the operator used in the operation. The specific operators available are not detailed in the specification. |
timeUnit | string | Required within parent | A string representing the unit of time involved in the operation. The specific time units available are not detailed in the specification. |
timeUnitCount | integer | Optional | An integer representing the count of the time units involved in the operation. Format: int32 |
useFiscalYear | boolean | Optional | A boolean indicating whether the fiscal year should be used in the operation. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string representing the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string specifying the default value to use for comparison if the comparison property is not set. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value for the property should be included in the operation. |
operationType | string | Required within parent | A string indicating the type of operation, which is always 'COMPARATIVE_DATE'. Default: COMPARATIVE_DATE One of: COMPARATIVE_DATE |
operator | string | Required within parent | A string that specifies the comparison operator used in the operation. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | |
defaultComparisonValue | string | Optional | |
includeObjectsWithNoValueSet | boolean | Required within parent | |
operationType | string | Required within parent | Default: COMPARATIVE_NUMBER One of: COMPARATIVE_NUMBER |
operator | string | Required within parent |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string specifying the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string that provides a default value for comparison if the property value is not set. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set for the property should be included in the operation. |
operationType | string | Required within parent | A string that indicates the type of operation being performed. It defaults to 'COMPARATIVE_STRING'. Default: COMPARATIVE_PROPERTY_UPDATED One of: COMPARATIVE_PROPERTY_UPDATED |
operator | string | Required within parent | A string representing the operator used in the comparison. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparisonPropertyName | string | Required within parent | A string specifying the name of the property to be compared. |
defaultComparisonValue | string | Optional | A string providing a default value for comparison if the property being compared has no value. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the property being compared. |
operationType | string | Required within parent | A string indicating the type of operation, which is 'COMPARATIVE_STRING' for this component. Default: COMPARATIVE_STRING One of: COMPARATIVE_STRING |
operator | string | Required within parent | A string representing the operator used in the comparison. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day component of the date. Format: int32 |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set should be included in the operation. |
month | string | Required within parent | A string representing the month component of the date. |
operationType | string | Required within parent | A string that specifies the type of operation. The default and only valid value is 'DATE'. Default: DATE One of: DATE |
operator | string | Required within parent | A string representing the operator used in the date operation. The specific operators are not detailed in the spec. |
year | integer | Required within parent | An integer representing the year component of the date. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a set value should be included in the operation. |
operationType | string | Required within parent | A string representing the type of operation. The default and only valid value is 'DATETIME'. Default: DATETIME One of: DATETIME |
operator | string | Required within parent | A string indicating the operator used in the operation. The specific operators are not detailed in the spec. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires conversion based on time zones. |
timestamp | integer | Required within parent | An integer representing the timestamp for the operation, formatted as an int64. Format: int64 |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the enumeration property. |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ENUMERATION' by default. Default: ENUMERATION One of: ENUMERATION |
operator | string | Required within parent | A string representing the operator to be used in the enumeration operation. |
values | array | Required within parent | An array of strings representing the values involved in the enumeration operation. |
values[] | string | Each item |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects without a value set should be included in the operation. |
operationType | string | Required within parent | A string that specifies the type of operation. The default value is 'MULTISTRING'. Default: MULTISTRING One of: MULTISTRING |
operator | string | Required within parent | A string that defines the operator used in the operation. |
values | array | Required within parent | An array of strings representing the values involved in the operation. |
values[] | string | Each item |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set for the property should be included in the operation. |
operationType | string | Required within parent | A string that specifies the type of operation. The default value is 'NUMBER'. Default: NUMBER One of: NUMBER |
operator | string | Required within parent | A string representing the operator used in the numeric operation. |
value | number | Required within parent | A number representing the value involved in the operation. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that do not have a value set for the property. |
lowerBound | integer | Required within parent | An integer specifying the lower bound of the range, in int64 format. Format: int64 |
operationType | string | Required within parent | A string that indicates the type of operation. The default value is 'RANGED_NUMBER'. Default: NUMBER_RANGED One of: NUMBER_RANGED |
operator | string | Required within parent | A string representing the operator used in the operation. |
upperBound | integer | Required within parent | An integer specifying the upper bound of the range, in int64 format. Format: int64 |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the date property. |
lowerBound | integer | Required within parent | An integer representing the lower bound of the date range, in Unix timestamp format (int64). Format: int64 |
operationType | string | Required within parent | A string indicating the type of operation, which is 'RANGED_DATE' by default. Default: RANGED_DATE One of: RANGED_DATE |
operator | string | Required within parent | A string representing the operator used in the operation. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires time zone conversion. |
upperBound | integer | Required within parent | An integer representing the upper bound of the date range, in Unix timestamp format (int64). Format: int64 |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set should be included in the operation. |
numberOfDays | integer | Required within parent | An integer specifying the number of days for the rolling date range. Format: int32 |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ROLLING_DATE_RANGE' for this component. Default: ROLLING_DATE_RANGE One of: ROLLING_DATE_RANGE |
operator | string | Required within parent | A string representing the operator used in the date range operation. |
requiresTimeZoneConversion | boolean | Required within parent | A boolean indicating whether the operation requires time zone conversion. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether objects with no value set should be included in the operation. |
numberOfDays | integer | Required within parent | An integer specifying the number of days over which the rolling update operation applies. Format: int32 |
operationType | string | Required within parent | A string indicating the type of operation, which is 'ROLLING_PROPERTY_UPDATED' for this component. Default: ROLLING_PROPERTY_UPDATED One of: ROLLING_PROPERTY_UPDATED |
operator | string | Required within parent | A string representing the operator used in the operation. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the property. |
operationType | string | Required within parent | A string indicating the type of operation, defaulting to 'STRING'. Default: STRING One of: STRING |
operator | string | Required within parent | A string specifying the operator used in the operation. |
value | string | Required within parent | A string representing the value associated with the operation. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filterType | string | Required within parent | A string representing the type of filter. The default value is 'SURVEY_MONKEY', and it must be 'SURVEY_MONKEY'. Default: SURVEY_MONKEY One of: SURVEY_MONKEY |
operator | string | Required within parent | A string representing the operation to be applied in the filter. The specific operations available are not detailed in the spec. |
surveyId | string | Required within parent | A string that specifies the unique identifier of the SurveyMonkey survey to be filtered. |
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
filterType | string | Required within parent | A string that specifies the type of filter being applied. The default value is 'WEBINAR'. Default: WEBINAR One of: WEBINAR |
operator | string | Required within parent | A string representing the operator used in the filter condition. |
webinarId | string | Optional | A string that uniquely identifies the webinar being filtered. |
Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — request body — body / filterBranch / filterBranchType: AND, Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — request body — body / filterBranch / filterBranchType: NOT ALL, Create tag — request body — body / filterBranch / filterBranchType: NOT ANY, Create tag — request body — body / filterBranch / filterBranchType: OR, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — request body — body / filterBranch / filterBranchType: AND, Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — request body — body / filterBranch / filterBranchType: NOT ALL, Create tag — request body — body / filterBranch / filterBranchType: NOT ANY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: OR, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — request body — body / filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endpointBehavior | string | Optional | A string describing the behavior of the endpoint. |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set. |
operationType | string | Required within parent | A string indicating the type of operation, which is 'TIME_POINT' by default. Default: TIME_POINT One of: TIME_POINT |
operator | string | Required within parent | A string representing the operator used in the operation. |
propertyParser | string | Optional | A string indicating the parser used for the property. |
timePoint | JSON | Required within parent | An object representing the specific time point, which can be a date point, indexed time point, or property-referenced time. |
timePoint (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
timePoint (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
timePoint (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED |
type | string | Required within parent | A string indicating the type of the operation. |
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day component of the date. Format: int32 |
hour | integer | Optional | An integer representing the hour component of the time. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond component of the time. Format: int32 |
minute | integer | Optional | An integer representing the minute component of the time. Format: int32 |
month | integer | Required within parent | An integer representing the month component of the date. Format: int32 |
second | integer | Optional | An integer representing the second component of the time. Format: int32 |
timeType | string | Required within parent | A string indicating the type of time reference used. Default: DATE One of: DATE |
timezoneSource | string | Optional | A string specifying the source of the timezone information. |
year | integer | Required within parent | An integer representing the year component of the date. Format: int32 |
zoneId | string | Required within parent | A string representing the identifier of the timezone. |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference day Of Week: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY, reference Type: WEEK
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dayOfWeek | string | Required within parent | A string indicating the day of the week. Valid values include 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', and 'SUNDAY'. One of: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond within the second. Format: int32 |
minute | integer | Optional | An integer representing the minute within the hour. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'WEEK' by default. Default: WEEK One of: WEEK |
second | integer | Optional | An integer representing the second within the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL QUARTER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day of the month. Format: int32 |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond of the second. Format: int32 |
minute | integer | Optional | An integer representing the minute of the hour. Format: int32 |
month | integer | Required within parent | An integer representing the month of the fiscal quarter. Format: int32 |
referenceType | string | Required within parent | A string that specifies the type of reference, defaulting to 'FISCAL_QUARTER'. Default: FISCAL_QUARTER One of: FISCAL_QUARTER |
second | integer | Optional | An integer representing the second of the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: FISCAL YEAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day of the month. Format: int32 |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond within the second. Format: int32 |
minute | integer | Optional | An integer representing the minute within the hour. Format: int32 |
month | integer | Required within parent | An integer representing the month of the fiscal year. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'FISCAL_YEAR' for this component. Default: FISCAL_YEAR One of: FISCAL_YEAR |
second | integer | Optional | An integer representing the second within the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: MONTH
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day of the month. Format: int32 |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond within the second. Format: int32 |
minute | integer | Optional | An integer representing the minute within the hour. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which defaults to 'MONTH'. Default: MONTH One of: MONTH |
second | integer | Optional | An integer representing the second within the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: NOW
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hour | integer | Optional | An integer representing the current hour. Format: int32 |
millisecond | integer | Optional | An integer representing the current millisecond. Format: int32 |
minute | integer | Optional | An integer representing the current minute. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which is always 'NOW'. Default: NOW One of: NOW |
second | integer | Optional | An integer representing the current second. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: QUARTER
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day within the month. Format: int32 |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond within the second. Format: int32 |
minute | integer | Optional | An integer representing the minute within the hour. Format: int32 |
month | integer | Required within parent | An integer representing the month within the quarter. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'QUARTER' by default. Default: QUARTER One of: QUARTER |
second | integer | Optional | An integer representing the second within the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: TODAY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
hour | integer | Optional | An integer representing the hour of the day. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond within the second. Format: int32 |
minute | integer | Optional | An integer representing the minute within the hour. Format: int32 |
referenceType | string | Required within parent | A string indicating the type of reference, which is always 'TODAY' for this component. Default: TODAY One of: TODAY |
second | integer | Optional | An integer representing the second within the minute. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED index Reference reference Type: YEAR
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
day | integer | Required within parent | An integer representing the day component of the date. Format: int32 |
hour | integer | Optional | An integer representing the hour component of the time. Format: int32 |
millisecond | integer | Optional | An integer representing the millisecond component of the time. Format: int32 |
minute | integer | Optional | An integer representing the minute component of the time. Format: int32 |
month | integer | Required within parent | An integer representing the month component of the date. Format: int32 |
referenceType | string | Required within parent | A string that specifies the type of reference, which is 'YEAR' by default. Default: YEAR One of: YEAR |
second | integer | Optional | An integer representing the second component of the time. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED offset
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
days | integer | Optional | An integer representing the number of days in the time offset. Format: int32 |
hours | integer | Optional | An integer representing the number of hours in the time offset. Format: int32 |
milliseconds | integer | Optional | An integer representing the number of milliseconds in the time offset. Format: int32 |
minutes | integer | Optional | An integer representing the number of minutes in the time offset. Format: int32 |
months | integer | Optional | An integer representing the number of months in the time offset. Format: int32 |
quarters | integer | Optional | An integer representing the number of quarters in the time offset. Format: int32 |
seconds | integer | Optional | An integer representing the number of seconds in the time offset. Format: int32 |
weeks | integer | Optional | An integer representing the number of weeks in the time offset. Format: int32 |
years | integer | Optional | An integer representing the number of years in the time offset. Format: int32 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
property | string | Required within parent | A string indicating the property within the CRM object that is being referenced for time operations. |
referenceType | string | Required within parent | A string defining the type of reference being used. |
timeType | string | Required within parent | A string indicating the type of time reference, which is 'PROPERTY_REFERENCED' by default. Default: PROPERTY_REFERENCED One of: PROPERTY_REFERENCED |
timezoneSource | string | Optional | A string specifying the source of the timezone information. |
zoneId | string | Required within parent | A string representing the identifier for the timezone. |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparison | string | Required within parent | A string representing the comparison operation to be performed. |
timestamp | integer | Required within parent | An integer representing the specific timestamp for comparison, formatted as an int64. Format: int64 |
type | string | Required within parent | A string indicating the type of refinement, which is 'ABSOLUTE_COMPARATIVE' by default. Default: ABSOLUTE_COMPARATIVE One of: ABSOLUTE_COMPARATIVE |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
lowerTimestamp | integer | Required within parent | An integer representing the lower boundary of the timestamp range, specified in Unix time format. Format: int64 |
rangeType | string | Required within parent | A string that specifies the type of range being used. |
type | string | Required within parent | A string indicating the type of refine by operation. The default value is 'ABSOLUTE_RANGED'. Default: ABSOLUTE_RANGED One of: ABSOLUTE_RANGED |
upperTimestamp | integer | Required within parent | An integer representing the upper boundary of the timestamp range, specified in Unix time format. Format: int64 |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | A string that specifies the type of refinement. The default and only valid value is 'ALL_HISTORY'. Default: ALL_HISTORY One of: ALL_HISTORY |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
maxOccurrences | integer | Optional | An integer representing the maximum number of occurrences allowed for the refinement. Format: int32 |
minOccurrences | integer | Optional | An integer representing the minimum number of occurrences required for the refinement. Format: int32 |
type | string | Required within parent | A string that specifies the type of refinement. The default value is 'NUM_OCCURRENCES'. Default: NUM_OCCURRENCES One of: NUM_OCCURRENCES |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
comparison | string | Required within parent | A string that specifies the type of comparison to be made with the timestamp. |
timeOffset | Model | Required within parent | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset |
type | string | Required within parent | A string that indicates the type of refinement, which is 'RELATIVE_COMPARATIVE' by default. Default: RELATIVE_COMPARATIVE One of: RELATIVE_COMPARATIVE |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amount | integer | Required within parent | An integer specifying the magnitude of the time offset in the specified time unit. Format: int64 |
offsetDirection | string | Required within parent | A string indicating the direction of the time offset. Valid values are 'BEFORE' and 'AFTER'. |
timeUnit | string | Required within parent | A string representing the unit of time for the offset, such as 'DAYS', 'HOURS', 'MINUTES', etc. |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
lowerBoundOffset | Model | Required within parent | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset |
rangeType | string | Required within parent | A string that defines the type of range for the timestamp refinement. |
type | string | Required within parent | A string that specifies the type of refine operation. The default value is 'RELATIVE_RANGED'. Default: RELATIVE_RANGED One of: RELATIVE_RANGED |
upperBoundOffset | Model | Required within parent | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
setType | string | Required within parent | A string representing the specific set type used for refining occurrences. |
type | string | Required within parent | A string that specifies the type of refinement. The default value is 'SET_OCCURRENCES'. Default: SET_OCCURRENCES One of: SET_OCCURRENCES |
Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
includeObjectsWithNoValueSet | boolean | Required within parent | A boolean indicating whether to include objects that have no value set for the specified property. |
lowerBoundEndpointBehavior | string | Optional | A string specifying the behavior at the lower endpoint of the time range. |
lowerBoundTimePoint | JSON | Required within parent | Defines the lower bound of the time range, which can be a date point, indexed time point, or property-referenced time. |
lowerBoundTimePoint (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
lowerBoundTimePoint (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
lowerBoundTimePoint (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED |
operationType | string | Required within parent | A string representing the type of operation being performed. |
operator | string | Required within parent | A string representing the operator used in the time-ranged operation. |
propertyParser | string | Optional | A string indicating the parser used for the property in the operation. |
type | string | Required within parent | A string indicating the type of operation, defaulting to 'TIME_RANGED'. Default: TIME_RANGED One of: TIME_RANGED |
upperBoundEndpointBehavior | string | Optional | A string specifying the behavior at the upper endpoint of the time range. |
upperBoundTimePoint | JSON | Required within parent | Defines the upper bound of the time range, which can be a date point, indexed time point, or property-referenced time. |
upperBoundTimePoint (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
upperBoundTimePoint (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
upperBoundTimePoint (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED |
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
Create tag — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | string | Required within parent | The color associated with the CRM object tag, represented as a string. |
createdAt | string | Required within parent | The date and time when the tag was created, in ISO 8601 format. Format: date-time |
createdBy | JSON | Optional | |
createdBy (anyOf 1) | integer | Alternative | An integer representing the ID of the user who created the tag. Format: int64 |
createdBy (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
description | string | Optional | A string providing a description of the CRM object tag. |
displayOrder | JSON | Required within parent | |
displayOrder (anyOf 1) | integer | Alternative | An integer indicating the display order of the tag. Format: int32 |
displayOrder (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
filterBranch | JSON | Required within parent | A complex object defining the filter branch associated with the tag, which can include various filter types and branches. |
filterBranch (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: OR |
filterBranch (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: AND |
filterBranch (anyOf 3) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: NOT ALL |
filterBranch (anyOf 4) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: NOT ANY |
filterBranch (anyOf 5) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: RESTRICTED |
filterBranch (anyOf 6) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranch (anyOf 7) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: ASSOCIATION |
filterPipelineIds | array | Required within parent | An array of strings representing the pipeline IDs that this tag is associated with. |
filterPipelineIds[] | string | Each item | |
id | string | Required within parent | The unique identifier for the CRM object tag, represented as a string. |
lastModifiedBy | JSON | Optional | |
lastModifiedBy (anyOf 1) | integer | Alternative | An integer representing the ID of the user who last modified the tag. Format: int64 |
lastModifiedBy (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
name | string | Required within parent | The name of the CRM object tag, represented as a string. |
objectTypeId | string | Required within parent | The identifier for the type of object this tag is associated with, represented as a string. |
updatedAt | string | Required within parent | The date and time when the tag was last updated, in ISO 8601 format. Format: date-time |
Referenced models: Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
Create tag — response body — filterBranch / filterBranchType: AND
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR
Create tag — response body — filterBranch / filterBranchType: ASSOCIATION
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS SEARCH, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ADS TIME, Create tag — response body — filterBranch / filterBranchType: AND, Create tag — response body — filterBranch / filterBranchType: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: ASSOCIATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: COMMUNICATION SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CONSTANT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: CTA, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EMAIL SUBSCRIPTION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: EVENT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: FORM SUBMISSION ON PAGE, operator: FILLED OUT, NOT FILLED OUT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: IN LIST, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: INTEGRATION EVENT, Create tag — response body — filterBranch / filterBranchType: NOT ALL, Create tag — response body — filterBranch / filterBranchType: NOT ANY, Create tag — response body — filterBranch / filterBranchType: OR, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PAGE VIEW, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PRIVACY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: SURVEY MONKEY VALUE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: WEBINAR