HubSpot: Object tags schemas (part 4)
30 HubSpot schemas with complete fields and constraints.
← Object tags operations · All schemas
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT
Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: UNIFIED EVENTS filter Lines item
Referenced models: Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ALL PROPERTY, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: BOOL, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: CALENDAR DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE STRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: DATETIME, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ENUMERATION, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: MULTISTRING, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: RANGED DATE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: NUMBER RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING DATE RANGE, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: ROLLING PROPERTY UPDATED, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: STRING, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, Create tag — response body — filterBranch / filterBranchType: OR filters item filter Type: PROPERTY operation operation Type: COMPARATIVE NUMBER
Create tag — response 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'. Known values: WEBINAR Default: 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 — response body — filterBranch / filterBranchType: RESTRICTED
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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED
Referenced models: Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ABSOLUTE RANGED, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: ALL HISTORY, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: NUM OCCURRENCES, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: TIME RANGED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE RANGED, Create tag — response body — filterBranch / filterBranchType: RESTRICTED, Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: SET OCCURRENCES, 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: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT, 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: 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. Known values: TIME_POINT Default: 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 (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
timePoint (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
timePoint (anyOf 3) | Model | Alternative | Expand Create tag — response 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 — response 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 — response 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 — response 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 — 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day component of the date. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour component of the time. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond component of the time. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute component of the time. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | An integer representing the month component of the date. Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second component of the time. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
timeType | string | Required within parent | A string indicating the type of time reference used. Known values: DATE Default: DATE |
timezoneSource | string | Optional | A string specifying the source of the timezone information. |
year | JSON | Required within parent | |
year (anyOf 1) | integer | Alternative | An integer representing the year component of the date. Format: int32 |
year (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
zoneId | string | Required within parent | A string representing the identifier of the timezone. |
Create tag — response 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 — response 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 — response 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 — response 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 — response 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 — response 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 — response 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 — response 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 — response 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 — response 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 — response 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'. Known values: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond within the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute within the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'WEEK' by default. Known values: WEEK Default: WEEK |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second within the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day of the month. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond of the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute of the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | An integer representing the month of the fiscal quarter. Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string that specifies the type of reference, defaulting to 'FISCAL_QUARTER'. Known values: FISCAL_QUARTER Default: FISCAL_QUARTER |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second of the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day of the month. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond within the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute within the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | An integer representing the month of the fiscal year. Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'FISCAL_YEAR' for this component. Known values: FISCAL_YEAR Default: FISCAL_YEAR |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second within the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day of the month. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond within the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute within the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which defaults to 'MONTH'. Known values: MONTH Default: MONTH |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second within the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the current hour. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the current millisecond. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the current minute. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which is always 'NOW'. Known values: NOW Default: NOW |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the current second. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day within the month. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond within the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute within the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | An integer representing the month within the quarter. Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which is 'QUARTER' by default. Known values: QUARTER Default: QUARTER |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second within the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour of the day. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond within the second. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute within the hour. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string indicating the type of reference, which is always 'TODAY' for this component. Known values: TODAY Default: TODAY |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second within the minute. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Required within parent | |
day (anyOf 1) | integer | Alternative | An integer representing the day component of the date. Format: int32 |
day (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hour | JSON | Optional | |
hour (anyOf 1) | integer | Alternative | An integer representing the hour component of the time. Format: int32 |
hour (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
millisecond | JSON | Optional | |
millisecond (anyOf 1) | integer | Alternative | An integer representing the millisecond component of the time. Format: int32 |
millisecond (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minute | JSON | Optional | |
minute (anyOf 1) | integer | Alternative | An integer representing the minute component of the time. Format: int32 |
minute (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
month | JSON | Required within parent | |
month (anyOf 1) | integer | Alternative | An integer representing the month component of the date. Format: int32 |
month (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
referenceType | string | Required within parent | A string that specifies the type of reference, which is 'YEAR' by default. Known values: YEAR Default: YEAR |
second | JSON | Optional | |
second (anyOf 1) | integer | Alternative | An integer representing the second component of the time. Format: int32 |
second (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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 | JSON | Optional | |
days (anyOf 1) | integer | Alternative | An integer representing the number of days in the time offset. Format: int32 |
days (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
hours | JSON | Optional | |
hours (anyOf 1) | integer | Alternative | An integer representing the number of hours in the time offset. Format: int32 |
hours (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
milliseconds | JSON | Optional | |
milliseconds (anyOf 1) | integer | Alternative | An integer representing the number of milliseconds in the time offset. Format: int32 |
milliseconds (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minutes | JSON | Optional | |
minutes (anyOf 1) | integer | Alternative | An integer representing the number of minutes in the time offset. Format: int32 |
minutes (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
months | JSON | Optional | |
months (anyOf 1) | integer | Alternative | An integer representing the number of months in the time offset. Format: int32 |
months (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
quarters | JSON | Optional | |
quarters (anyOf 1) | integer | Alternative | An integer representing the number of quarters in the time offset. Format: int32 |
quarters (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
seconds | JSON | Optional | |
seconds (anyOf 1) | integer | Alternative | An integer representing the number of seconds in the time offset. Format: int32 |
seconds (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
weeks | JSON | Optional | |
weeks (anyOf 1) | integer | Alternative | An integer representing the number of weeks in the time offset. Format: int32 |
weeks (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
years | JSON | Optional | |
years (anyOf 1) | integer | Alternative | An integer representing the number of years in the time offset. Format: int32 |
years (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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. Known values: PROPERTY_REFERENCED Default: 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 — response 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 | JSON | Required within parent | |
timestamp (anyOf 1) | integer | Alternative | An integer representing the specific timestamp for comparison, formatted as an int64. Format: int64 |
timestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | A string indicating the type of refinement, which is 'ABSOLUTE_COMPARATIVE' by default. Known values: ABSOLUTE_COMPARATIVE Default: ABSOLUTE_COMPARATIVE |
Create tag — response 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 | JSON | Required within parent | |
lowerTimestamp (anyOf 1) | integer | Alternative | An integer representing the lower boundary of the timestamp range, specified in Unix time format. Format: int64 |
lowerTimestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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'. Known values: ABSOLUTE_RANGED Default: ABSOLUTE_RANGED |
upperTimestamp | JSON | Required within parent | |
upperTimestamp (anyOf 1) | integer | Alternative | An integer representing the upper boundary of the timestamp range, specified in Unix time format. Format: int64 |
upperTimestamp (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create tag — response 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'. Known values: ALL_HISTORY Default: ALL_HISTORY |
Create tag — response 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 | JSON | Optional | |
maxOccurrences (anyOf 1) | integer | Alternative | An integer representing the maximum number of occurrences allowed for the refinement. Format: int32 |
maxOccurrences (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
minOccurrences | JSON | Optional | |
minOccurrences (anyOf 1) | integer | Alternative | An integer representing the minimum number of occurrences required for the refinement. Format: int32 |
minOccurrences (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | A string that specifies the type of refinement. The default value is 'NUM_OCCURRENCES'. Known values: NUM_OCCURRENCES Default: NUM_OCCURRENCES |
Create tag — response 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 — response 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. Known values: RELATIVE_COMPARATIVE Default: RELATIVE_COMPARATIVE |
Create tag — response 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 | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | An integer specifying the magnitude of the time offset in the specified time unit. Format: int64 |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
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 — response 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 — response 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'. Known values: RELATIVE_RANGED Default: RELATIVE_RANGED |
upperBoundOffset | Model | Required within parent | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By type: RELATIVE COMPARATIVE time Offset |
Create tag — response 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'. Known values: SET_OCCURRENCES Default: SET_OCCURRENCES |
Create tag — response 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 (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
lowerBoundTimePoint (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
lowerBoundTimePoint (anyOf 3) | Model | Alternative | Expand Create tag — response 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'. Known values: TIME_RANGED Default: 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 (anyOf 1) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: DATE |
upperBoundTimePoint (anyOf 2) | Model | Alternative | Expand Create tag — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: INDEXED |
upperBoundTimePoint (anyOf 3) | Model | Alternative | Expand Create tag — response 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 — response 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 — response 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 — response body — filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED pruning Refine By operation Type: TIME POINT time Point time Type: PROPERTY REFERENCED
Retrieve tags — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
results | array | Required within parent | An array of CRM object tags. Each item in the array is a PublicCrmObjectTag object. |
results[] | Model | Each item | Expand Create tag — response body |
Referenced models: Create tag — response body
Update tag (Partial) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | object | Required within parent | An object representing the new color for the CRM object tag. |
description | object | Required within parent | An object representing the new description for the CRM object tag. |
filterBranch | object | Required within parent | An object representing the new filter branch for the CRM object tag. |
filterPipelineIds | object | Required within parent | An object representing the new set of pipeline IDs associated with the CRM object tag. |
name | object | Required within parent | An object representing the new name for the CRM object tag. |
Update tag (Replace) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
color | string | Required within parent | A string specifying the color associated with the CRM object tag. |
description | string | Optional | A string providing a description of the CRM object tag. |
filterBranch | JSON | Required within parent | An object that defines the filter branch for the CRM object tag. It can be one of several filter branch types, such as PublicOrFilterBranch or PublicAndFilterBranch. |
filterBranch (oneOf 1) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: OR |
filterBranch (oneOf 2) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: AND |
filterBranch (oneOf 3) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ALL |
filterBranch (oneOf 4) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: NOT ANY |
filterBranch (oneOf 5) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: RESTRICTED |
filterBranch (oneOf 6) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED |
filterBranch (oneOf 7) | Model | Alternative | Expand Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION |
filterPipelineIds | array | Required within parent | An array of strings representing the IDs of the pipelines to which the CRM object tag is applicable. |
filterPipelineIds[] | string | Each item | |
name | string | Required within parent | A string representing the name of the CRM object tag. |
Referenced models: Create tag — request body — body / filterBranch / filterBranchType: AND, Create tag — request body — body / filterBranch / filterBranchType: ASSOCIATION, 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: RESTRICTED, Create tag — request body — body / filterBranch / filterBranchType: UNIFIED EVENTS, operator: HAS COMPLETED, HAS NOT COMPLETED