--- title: "Unlock a campaign" method: POST path: "/v2/campaigns/{campaignId}{version}/unlock" tags: ["Campaigns"] --- # Unlock a campaign `POST /v2/campaigns/{campaignId}{version}/unlock` Releases the edit lock on the specified campaign version. After unlocking, other callers can edit the campaign again. Returns `400 campaign_not_locked` if the campaign is not currently locked by the caller. ## Path parameters - `campaignId` string, required - `version` string, required ## Request body - CampaignUnlockRequest - `lock_types` string[], required ## Response `200` Successful response - CampaignResponse — Stored campaign definition. Fields `variant_selector` and `variants` are unevaluated and appear in buildtime-evaluatable form. - `campaign_id` string, required - `campaign_locks` string[], required - `campaign_type` 'CONFIGURATION' | 'EXTENSION' | 'INTEGRATION' | 'MARKETING', required - `components` CampaignComponentResponse[], required - `assets` ComponentAssetResponse[], required - `description` string - `filename` string - `id` string - `name` string - `tags` string[] - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `description` string, required - `display_name` union, required — The display name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal display name - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `facets` CampaignComponentFacetResponse[], required - `name` string - `value` string - `id` string, required - `install` union, required — The install as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal install - string — Handlebars expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). - string — Javascript expression with [ComponentInstalltimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/component/install/ComponentInstalltimeContext.d.ts). - `installed_into_socket` string, required - `name` string, required - `origin` ComponentOriginResponse, required - `client_id` string - `component_id` string - `component_version` integer - `tags` string[], required - `type` string, required - `types` string[], required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `upload_version` string, required - `variables` CampaignComponentSettingResponse[], required - union - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'ADMIN_ICON', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'AUDIENCE_ID', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'AUDIENCE_ID_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'BOOLEAN', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'BROWSER_SIDE_JAVASCRIPT', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'CLIENT_DOMAIN_ID_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'CLIENT_KEY', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component client key flow variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'CLIENT_KEY_FLOW', required - `authorization_url` string, required - `client_secret_key_id` string, required - `redirect_url` string, required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'COLOR', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component component id variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'COMPONENT_ID', required - `filter` ComponentIdFilterResponse, required - `component_types` string[] - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component component setting lookup variable definition. Fields `description` and `captured_setting_values_description` are unevaluated and appear in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'COMPONENT_SETTING_LOOKUP', required - `capture_settings` string[], required - `captured_setting_values_description` union, required — The captured setting values description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `filters` SettingFilterResponse[], required - union - … - `matching_filters` SettingFilterResponse[], required - union - … - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'CSS', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'DELAY', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'DELAY_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component enum variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'ENUM', required - `allowed_values` string[], required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component enum list variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'ENUM_LIST', required - `allowed_values` string[], required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'EXTOLE_CLIENT_KEY', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'FONT', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'GLOB_COMPONENT_PATH', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'HTML', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'IMAGE', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'INTEGER', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'INTEGER_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'JSON', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component socket definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'MULTI_SOCKET', required - `filters` SettingFilterResponse[], required - union - … - `parameters` CampaignComponentVariableResponse[], required - `description` union — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - … - `display_name` string - `name` string - `priority` string - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `tags` string[] - `type` 'ADMIN_ICON' | 'AUDIENCE_ID' | 'AUDIENCE_ID_LIST' | 'BOOLEAN' | 'BROWSER_SIDE_JAVASCRIPT' | 'CLIENT_DOMAIN_ID_LIST' | 'CLIENT_KEY' | 'CLIENT_KEY_FLOW' | 'COLOR' | 'COMPONENT_ID' | 'COMPONENT_SETTING_LOOKUP' | 'CSS' | 'DELAY' | 'DELAY_LIST' | 'ENUM' | 'ENUM_LIST' | 'EXTOLE_CLIENT_KEY' | 'FONT' | 'GLOB_COMPONENT_PATH' | 'HTML' | 'IMAGE' | 'INTEGER' | 'INTEGER_LIST' | 'JSON' | 'MULTI_SOCKET' | 'PARTNER_ENUM' | 'PARTNER_ENUM_LIST' | 'PERSON_KEY_NAME' | 'REWARD_SUPPLIER_ID' | 'REWARD_SUPPLIER_ID_LIST' | 'SOCKET' | 'STRING' | 'STRING_LIST' | 'STRING_MAP' | 'URL' | 'WEBHOOK_ID' - `values` ComponentSettingVariableValues — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - … - `socketed_component_ids` string[], required - object — Stored campaign component partner enum variable definition. Fields `description` and `webhook_id` are unevaluated and appear in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'PARTNER_ENUM', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - `webhook_id` union, required — The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal webhook id - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `options` PartnerEnumListVariableOptionResponse[], required - `id` string - `name` string - object — Stored campaign component partner enum list variable definition. Fields `description` and `webhook_id` are unevaluated and appear in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'PARTNER_ENUM_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - `webhook_id` union, required — The webhook id as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal webhook id - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `options` PartnerEnumListVariableOptionResponse[], required - `id` string - `name` string - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'PERSON_KEY_NAME', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'REWARD_SUPPLIER_ID', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component reward supplier id list variable definition. Fields `description` and `allowed_reward_supplier_ids` are unevaluated and appear in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'REWARD_SUPPLIER_ID_LIST', required - `allowed_reward_supplier_ids` union, required — The allowed reward supplier ids as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal allowed reward supplier ids - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component socket definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'SOCKET', required - `filters` SettingFilterResponse[], required - union - … - `parameters` CampaignComponentVariableResponse[], required - `description` union — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - … - `display_name` string - `name` string - `priority` string - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `tags` string[] - `type` 'ADMIN_ICON' | 'AUDIENCE_ID' | 'AUDIENCE_ID_LIST' | 'BOOLEAN' | 'BROWSER_SIDE_JAVASCRIPT' | 'CLIENT_DOMAIN_ID_LIST' | 'CLIENT_KEY' | 'CLIENT_KEY_FLOW' | 'COLOR' | 'COMPONENT_ID' | 'COMPONENT_SETTING_LOOKUP' | 'CSS' | 'DELAY' | 'DELAY_LIST' | 'ENUM' | 'ENUM_LIST' | 'EXTOLE_CLIENT_KEY' | 'FONT' | 'GLOB_COMPONENT_PATH' | 'HTML' | 'IMAGE' | 'INTEGER' | 'INTEGER_LIST' | 'JSON' | 'MULTI_SOCKET' | 'PARTNER_ENUM' | 'PARTNER_ENUM_LIST' | 'PERSON_KEY_NAME' | 'REWARD_SUPPLIER_ID' | 'REWARD_SUPPLIER_ID_LIST' | 'SOCKET' | 'STRING' | 'STRING_LIST' | 'STRING_MAP' | 'URL' | 'WEBHOOK_ID' - `values` ComponentSettingVariableValues — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - … - `socketed_component_ids` string[], required - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'STRING', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'STRING_LIST', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object — Stored campaign component string map variable definition. Field `description` is unevaluated and appears in buildtime-evaluatable form. - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'STRING_MAP', required - `allowed_keys` string[], required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER', required - `values` object, required — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'URL', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - object - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `display_name` string, required - `name` string, required - `priority` string, required - `tags` string[], required - `type` 'WEBHOOK_ID', required - `source` 'INHERITED' | 'LOCAL' | 'PARAMETER' - `values` object — Open map of setting values keyed by value key. There is no fixed or maximum number of keys. Any string key may be present; each value uses the same shape for this setting's `type`. The properties listed here are common examples only and are not required. - `default` union — Example value key. Fallback when no locale- or environment-specific key matches. Omitting `default` is valid when another key applies. - … - `en` union — Example locale value key. Use any locale or environment code as the key; `en` is shown only as a representative example. - … - `version` integer, required - `description` string, required - `end_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `flow_steps` CampaignFlowStepResponse[], required - `apps` CampaignFlowStepAppResponse[], required - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Literal description - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `type` CampaignFlowStepAppTypeResponse, required - `name` union — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string, nullable — Literal description - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `flow_path` union, required — The flow path as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `flow_step_id` string, required - `icon_color` union, required — The icon color as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `icon_type` union, required — The icon type as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `metrics` CampaignFlowStepMetricResponse[], required - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `description` union, required — The description as configured: a literal value, or an expression (type:string) when defined dynamically. - string, nullable — Literal description - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `expression` union, required — The expression as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `id` string, required - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `tags` union, required — The tags as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal tags - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `unit` union, required — The unit as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `sequence` union, required — The sequence as configured: a literal value, or an expression (type:string) when defined dynamically. - number — Literal sequence - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `step_name` union, required — The step name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `tags` union, required — The tags as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal tags - string — Handlebars expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - string — Javascript expression with [AllFlowStepsBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/AllFlowStepsBuildtimeContext.d.ts). - `words` CampaignFlowStepWordsResponse, required - `person_counting_name` union — The person counting name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - string — Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - `plural_noun_name` union — The plural noun name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - string — Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - `rate_name` union — The rate name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - string — Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - `singular_noun_name` union — The singular noun name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - string — Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - `verb_name` union — The verb name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - string — Javascript expression with [FlowStepBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/FlowStepBuildtimeContext.d.ts). - `incentive` IncentiveResponse, required - `id` string, required - `quality_rules` QualityRuleResponse[], required - `action_types` string[], required - `enabled` boolean, required - `id` string, required - `properties` object, required - `rule_type` 'BAD_COUNTRY' | 'BLACKLIST_DOMAIN' | 'BLACKLIST_REFERER_HEADER' | 'BLOCKED' | 'BOT_FILTER' | 'EVENT_SPEED' | 'EXISTING_CUSTOMER' | 'FRIENDS_OF_ADVOCATE_CLICK_LIMIT' | 'FRIENDS_OF_ADVOCATE_CONVERSION_LIMIT' | 'FRIENDS_OF_ADVOCATE_REGISTRATION_LIMIT' | 'GENERIC' | 'GLOBAL_BLOCK' | 'IP_FILTER' | 'PERSON_DATA' | 'PREVIEW' | 'PROFILE_DISPLACED' | 'RECENT_CUSTOMER' | 'RECIPIENT_LIMIT' | 'REFERRAL_AGE' | 'REFERRAL_CAP' | 'SAME_IP' | 'SELF_REFERRAL' | 'SHARE_COUNT_LIMIT' | 'SIMILAR_FRIEND_ADVOCATE_EMAIL' | 'SPAM_MESSAGE' | 'VALID_EMAIL', required - `reward_rules` RewardRuleResponse[], required - `count_rewards_based_on_partner_user_id` boolean, nullable, required - `data_attribute_matcher_type` 'EXACT' | 'REGEX', nullable, required - `data_attribute_name` string, nullable, required - `data_attribute_value` string, nullable, required - `expression` RewardRuleExpression, required - `type` 'JS' | 'SPEL' - `value` string - `id` string, required - `is_email_required` boolean, required - `is_referral_loop_allowed` boolean, required - `is_unique_friend_required` boolean, required - `min_cart_value` number, required - `referrals_per_reward` integer, required - `reward_count_limit` integer, required - `reward_count_since_days` integer, nullable, required - `reward_count_since_month` integer, nullable, required - `reward_every_x_friend_actions` integer, nullable, required - `reward_slots` string[], required - `reward_supplier_id` string, required - `reward_value_limit` number, required - `reward_value_since_days` integer, nullable, required - `reward_value_since_month` integer, nullable, required - `rewardee` 'ADVOCATE' | 'FRIEND', required - `trigger_action_type` 'ANY_CLICK' | 'ANY_PROMOTION' | 'ANY_PURCHASE' | 'ANY_REGISTER' | 'ANY_SHARE' | 'ANY_SHARE_REWARD' | 'GENERIC_ACTION_1' | 'GENERIC_ACTION_10' | 'GENERIC_ACTION_100' | 'GENERIC_ACTION_101' | 'GENERIC_ACTION_102' | 'GENERIC_ACTION_103' | 'GENERIC_ACTION_104' | 'GENERIC_ACTION_105' | 'GENERIC_ACTION_106' | 'GENERIC_ACTION_107' | 'GENERIC_ACTION_108' | 'GENERIC_ACTION_109' | 'GENERIC_ACTION_11' | 'GENERIC_ACTION_110' | 'GENERIC_ACTION_111' | 'GENERIC_ACTION_112' | 'GENERIC_ACTION_113' | 'GENERIC_ACTION_114' | 'GENERIC_ACTION_115' | 'GENERIC_ACTION_116' | 'GENERIC_ACTION_117' | 'GENERIC_ACTION_118' | 'GENERIC_ACTION_119' | 'GENERIC_ACTION_12' | 'GENERIC_ACTION_120' | 'GENERIC_ACTION_121' | 'GENERIC_ACTION_122' | 'GENERIC_ACTION_123' | 'GENERIC_ACTION_124' | 'GENERIC_ACTION_125' | 'GENERIC_ACTION_126' | 'GENERIC_ACTION_127' | 'GENERIC_ACTION_128' | 'GENERIC_ACTION_129' | 'GENERIC_ACTION_13' | 'GENERIC_ACTION_130' | 'GENERIC_ACTION_131' | 'GENERIC_ACTION_132' | 'GENERIC_ACTION_133' | 'GENERIC_ACTION_134' | 'GENERIC_ACTION_135' | 'GENERIC_ACTION_136' | 'GENERIC_ACTION_137' | 'GENERIC_ACTION_138' | 'GENERIC_ACTION_139' | 'GENERIC_ACTION_14' | 'GENERIC_ACTION_140' | 'GENERIC_ACTION_141' | 'GENERIC_ACTION_142' | 'GENERIC_ACTION_143' | 'GENERIC_ACTION_144' | 'GENERIC_ACTION_145' | 'GENERIC_ACTION_146' | 'GENERIC_ACTION_147' | 'GENERIC_ACTION_148' | 'GENERIC_ACTION_149' | 'GENERIC_ACTION_15' | 'GENERIC_ACTION_150' | 'GENERIC_ACTION_151' | 'GENERIC_ACTION_152' | 'GENERIC_ACTION_153' | 'GENERIC_ACTION_154' | 'GENERIC_ACTION_155' | 'GENERIC_ACTION_156' | 'GENERIC_ACTION_157' | 'GENERIC_ACTION_158' | 'GENERIC_ACTION_159' | 'GENERIC_ACTION_16' | 'GENERIC_ACTION_160' | 'GENERIC_ACTION_161' | 'GENERIC_ACTION_162' | 'GENERIC_ACTION_163' | 'GENERIC_ACTION_164' | 'GENERIC_ACTION_165' | 'GENERIC_ACTION_166' | 'GENERIC_ACTION_167' | 'GENERIC_ACTION_168' | 'GENERIC_ACTION_169' | 'GENERIC_ACTION_17' | 'GENERIC_ACTION_170' | 'GENERIC_ACTION_171' | 'GENERIC_ACTION_172' | 'GENERIC_ACTION_173' | 'GENERIC_ACTION_174' | 'GENERIC_ACTION_175' | 'GENERIC_ACTION_176' | 'GENERIC_ACTION_177' | 'GENERIC_ACTION_178' | 'GENERIC_ACTION_179' | 'GENERIC_ACTION_18' | 'GENERIC_ACTION_180' | 'GENERIC_ACTION_181' | 'GENERIC_ACTION_182' | 'GENERIC_ACTION_183' | 'GENERIC_ACTION_184' | 'GENERIC_ACTION_185' | 'GENERIC_ACTION_186' | 'GENERIC_ACTION_187' | 'GENERIC_ACTION_188' | 'GENERIC_ACTION_189' | 'GENERIC_ACTION_19' | 'GENERIC_ACTION_190' | 'GENERIC_ACTION_191' | 'GENERIC_ACTION_192' | 'GENERIC_ACTION_193' | 'GENERIC_ACTION_194' | 'GENERIC_ACTION_195' | 'GENERIC_ACTION_196' | 'GENERIC_ACTION_197' | 'GENERIC_ACTION_198' | 'GENERIC_ACTION_199' | 'GENERIC_ACTION_2' | 'GENERIC_ACTION_20' | 'GENERIC_ACTION_200' | 'GENERIC_ACTION_21' | 'GENERIC_ACTION_22' | 'GENERIC_ACTION_23' | 'GENERIC_ACTION_24' | 'GENERIC_ACTION_25' | 'GENERIC_ACTION_26' | 'GENERIC_ACTION_27' | 'GENERIC_ACTION_28' | 'GENERIC_ACTION_29' | 'GENERIC_ACTION_3' | 'GENERIC_ACTION_30' | 'GENERIC_ACTION_31' | 'GENERIC_ACTION_32' | 'GENERIC_ACTION_33' | 'GENERIC_ACTION_34' | 'GENERIC_ACTION_35' | 'GENERIC_ACTION_36' | 'GENERIC_ACTION_37' | 'GENERIC_ACTION_38' | 'GENERIC_ACTION_39' | 'GENERIC_ACTION_4' | 'GENERIC_ACTION_40' | 'GENERIC_ACTION_41' | 'GENERIC_ACTION_42' | 'GENERIC_ACTION_43' | 'GENERIC_ACTION_44' | 'GENERIC_ACTION_45' | 'GENERIC_ACTION_46' | 'GENERIC_ACTION_47' | 'GENERIC_ACTION_48' | 'GENERIC_ACTION_49' | 'GENERIC_ACTION_5' | 'GENERIC_ACTION_50' | 'GENERIC_ACTION_51' | 'GENERIC_ACTION_52' | 'GENERIC_ACTION_53' | 'GENERIC_ACTION_54' | 'GENERIC_ACTION_55' | 'GENERIC_ACTION_56' | 'GENERIC_ACTION_57' | 'GENERIC_ACTION_58' | 'GENERIC_ACTION_59' | 'GENERIC_ACTION_6' | 'GENERIC_ACTION_60' | 'GENERIC_ACTION_61' | 'GENERIC_ACTION_62' | 'GENERIC_ACTION_63' | 'GENERIC_ACTION_64' | 'GENERIC_ACTION_65' | 'GENERIC_ACTION_66' | 'GENERIC_ACTION_67' | 'GENERIC_ACTION_68' | 'GENERIC_ACTION_69' | 'GENERIC_ACTION_7' | 'GENERIC_ACTION_70' | 'GENERIC_ACTION_71' | 'GENERIC_ACTION_72' | 'GENERIC_ACTION_73' | 'GENERIC_ACTION_74' | 'GENERIC_ACTION_75' | 'GENERIC_ACTION_76' | 'GENERIC_ACTION_77' | 'GENERIC_ACTION_78' | 'GENERIC_ACTION_79' | 'GENERIC_ACTION_8' | 'GENERIC_ACTION_80' | 'GENERIC_ACTION_81' | 'GENERIC_ACTION_82' | 'GENERIC_ACTION_83' | 'GENERIC_ACTION_84' | 'GENERIC_ACTION_85' | 'GENERIC_ACTION_86' | 'GENERIC_ACTION_87' | 'GENERIC_ACTION_88' | 'GENERIC_ACTION_89' | 'GENERIC_ACTION_9' | 'GENERIC_ACTION_90' | 'GENERIC_ACTION_91' | 'GENERIC_ACTION_92' | 'GENERIC_ACTION_93' | 'GENERIC_ACTION_94' | 'GENERIC_ACTION_95' | 'GENERIC_ACTION_96' | 'GENERIC_ACTION_97' | 'GENERIC_ACTION_98' | 'GENERIC_ACTION_99' | 'THEME_GENERIC_ACTION_1' | 'THEME_GENERIC_ACTION_10' | 'THEME_GENERIC_ACTION_11' | 'THEME_GENERIC_ACTION_12' | 'THEME_GENERIC_ACTION_13' | 'THEME_GENERIC_ACTION_14' | 'THEME_GENERIC_ACTION_15' | 'THEME_GENERIC_ACTION_16' | 'THEME_GENERIC_ACTION_17' | 'THEME_GENERIC_ACTION_18' | 'THEME_GENERIC_ACTION_19' | 'THEME_GENERIC_ACTION_2' | 'THEME_GENERIC_ACTION_20' | 'THEME_GENERIC_ACTION_21' | 'THEME_GENERIC_ACTION_22' | 'THEME_GENERIC_ACTION_23' | 'THEME_GENERIC_ACTION_24' | 'THEME_GENERIC_ACTION_25' | 'THEME_GENERIC_ACTION_26' | 'THEME_GENERIC_ACTION_27' | 'THEME_GENERIC_ACTION_28' | 'THEME_GENERIC_ACTION_29' | 'THEME_GENERIC_ACTION_3' | 'THEME_GENERIC_ACTION_30' | 'THEME_GENERIC_ACTION_4' | 'THEME_GENERIC_ACTION_5' | 'THEME_GENERIC_ACTION_6' | 'THEME_GENERIC_ACTION_7' | 'THEME_GENERIC_ACTION_8' | 'THEME_GENERIC_ACTION_9', required - `transition_rules` TransitionRuleResponse[], required - `action_type` 'ANY_CLICK' | 'ANY_PROMOTION' | 'ANY_PURCHASE' | 'ANY_REGISTER' | 'ANY_SHARE' | 'ANY_SHARE_REWARD' | 'GENERIC_ACTION_1' | 'GENERIC_ACTION_10' | 'GENERIC_ACTION_100' | 'GENERIC_ACTION_101' | 'GENERIC_ACTION_102' | 'GENERIC_ACTION_103' | 'GENERIC_ACTION_104' | 'GENERIC_ACTION_105' | 'GENERIC_ACTION_106' | 'GENERIC_ACTION_107' | 'GENERIC_ACTION_108' | 'GENERIC_ACTION_109' | 'GENERIC_ACTION_11' | 'GENERIC_ACTION_110' | 'GENERIC_ACTION_111' | 'GENERIC_ACTION_112' | 'GENERIC_ACTION_113' | 'GENERIC_ACTION_114' | 'GENERIC_ACTION_115' | 'GENERIC_ACTION_116' | 'GENERIC_ACTION_117' | 'GENERIC_ACTION_118' | 'GENERIC_ACTION_119' | 'GENERIC_ACTION_12' | 'GENERIC_ACTION_120' | 'GENERIC_ACTION_121' | 'GENERIC_ACTION_122' | 'GENERIC_ACTION_123' | 'GENERIC_ACTION_124' | 'GENERIC_ACTION_125' | 'GENERIC_ACTION_126' | 'GENERIC_ACTION_127' | 'GENERIC_ACTION_128' | 'GENERIC_ACTION_129' | 'GENERIC_ACTION_13' | 'GENERIC_ACTION_130' | 'GENERIC_ACTION_131' | 'GENERIC_ACTION_132' | 'GENERIC_ACTION_133' | 'GENERIC_ACTION_134' | 'GENERIC_ACTION_135' | 'GENERIC_ACTION_136' | 'GENERIC_ACTION_137' | 'GENERIC_ACTION_138' | 'GENERIC_ACTION_139' | 'GENERIC_ACTION_14' | 'GENERIC_ACTION_140' | 'GENERIC_ACTION_141' | 'GENERIC_ACTION_142' | 'GENERIC_ACTION_143' | 'GENERIC_ACTION_144' | 'GENERIC_ACTION_145' | 'GENERIC_ACTION_146' | 'GENERIC_ACTION_147' | 'GENERIC_ACTION_148' | 'GENERIC_ACTION_149' | 'GENERIC_ACTION_15' | 'GENERIC_ACTION_150' | 'GENERIC_ACTION_151' | 'GENERIC_ACTION_152' | 'GENERIC_ACTION_153' | 'GENERIC_ACTION_154' | 'GENERIC_ACTION_155' | 'GENERIC_ACTION_156' | 'GENERIC_ACTION_157' | 'GENERIC_ACTION_158' | 'GENERIC_ACTION_159' | 'GENERIC_ACTION_16' | 'GENERIC_ACTION_160' | 'GENERIC_ACTION_161' | 'GENERIC_ACTION_162' | 'GENERIC_ACTION_163' | 'GENERIC_ACTION_164' | 'GENERIC_ACTION_165' | 'GENERIC_ACTION_166' | 'GENERIC_ACTION_167' | 'GENERIC_ACTION_168' | 'GENERIC_ACTION_169' | 'GENERIC_ACTION_17' | 'GENERIC_ACTION_170' | 'GENERIC_ACTION_171' | 'GENERIC_ACTION_172' | 'GENERIC_ACTION_173' | 'GENERIC_ACTION_174' | 'GENERIC_ACTION_175' | 'GENERIC_ACTION_176' | 'GENERIC_ACTION_177' | 'GENERIC_ACTION_178' | 'GENERIC_ACTION_179' | 'GENERIC_ACTION_18' | 'GENERIC_ACTION_180' | 'GENERIC_ACTION_181' | 'GENERIC_ACTION_182' | 'GENERIC_ACTION_183' | 'GENERIC_ACTION_184' | 'GENERIC_ACTION_185' | 'GENERIC_ACTION_186' | 'GENERIC_ACTION_187' | 'GENERIC_ACTION_188' | 'GENERIC_ACTION_189' | 'GENERIC_ACTION_19' | 'GENERIC_ACTION_190' | 'GENERIC_ACTION_191' | 'GENERIC_ACTION_192' | 'GENERIC_ACTION_193' | 'GENERIC_ACTION_194' | 'GENERIC_ACTION_195' | 'GENERIC_ACTION_196' | 'GENERIC_ACTION_197' | 'GENERIC_ACTION_198' | 'GENERIC_ACTION_199' | 'GENERIC_ACTION_2' | 'GENERIC_ACTION_20' | 'GENERIC_ACTION_200' | 'GENERIC_ACTION_21' | 'GENERIC_ACTION_22' | 'GENERIC_ACTION_23' | 'GENERIC_ACTION_24' | 'GENERIC_ACTION_25' | 'GENERIC_ACTION_26' | 'GENERIC_ACTION_27' | 'GENERIC_ACTION_28' | 'GENERIC_ACTION_29' | 'GENERIC_ACTION_3' | 'GENERIC_ACTION_30' | 'GENERIC_ACTION_31' | 'GENERIC_ACTION_32' | 'GENERIC_ACTION_33' | 'GENERIC_ACTION_34' | 'GENERIC_ACTION_35' | 'GENERIC_ACTION_36' | 'GENERIC_ACTION_37' | 'GENERIC_ACTION_38' | 'GENERIC_ACTION_39' | 'GENERIC_ACTION_4' | 'GENERIC_ACTION_40' | 'GENERIC_ACTION_41' | 'GENERIC_ACTION_42' | 'GENERIC_ACTION_43' | 'GENERIC_ACTION_44' | 'GENERIC_ACTION_45' | 'GENERIC_ACTION_46' | 'GENERIC_ACTION_47' | 'GENERIC_ACTION_48' | 'GENERIC_ACTION_49' | 'GENERIC_ACTION_5' | 'GENERIC_ACTION_50' | 'GENERIC_ACTION_51' | 'GENERIC_ACTION_52' | 'GENERIC_ACTION_53' | 'GENERIC_ACTION_54' | 'GENERIC_ACTION_55' | 'GENERIC_ACTION_56' | 'GENERIC_ACTION_57' | 'GENERIC_ACTION_58' | 'GENERIC_ACTION_59' | 'GENERIC_ACTION_6' | 'GENERIC_ACTION_60' | 'GENERIC_ACTION_61' | 'GENERIC_ACTION_62' | 'GENERIC_ACTION_63' | 'GENERIC_ACTION_64' | 'GENERIC_ACTION_65' | 'GENERIC_ACTION_66' | 'GENERIC_ACTION_67' | 'GENERIC_ACTION_68' | 'GENERIC_ACTION_69' | 'GENERIC_ACTION_7' | 'GENERIC_ACTION_70' | 'GENERIC_ACTION_71' | 'GENERIC_ACTION_72' | 'GENERIC_ACTION_73' | 'GENERIC_ACTION_74' | 'GENERIC_ACTION_75' | 'GENERIC_ACTION_76' | 'GENERIC_ACTION_77' | 'GENERIC_ACTION_78' | 'GENERIC_ACTION_79' | 'GENERIC_ACTION_8' | 'GENERIC_ACTION_80' | 'GENERIC_ACTION_81' | 'GENERIC_ACTION_82' | 'GENERIC_ACTION_83' | 'GENERIC_ACTION_84' | 'GENERIC_ACTION_85' | 'GENERIC_ACTION_86' | 'GENERIC_ACTION_87' | 'GENERIC_ACTION_88' | 'GENERIC_ACTION_89' | 'GENERIC_ACTION_9' | 'GENERIC_ACTION_90' | 'GENERIC_ACTION_91' | 'GENERIC_ACTION_92' | 'GENERIC_ACTION_93' | 'GENERIC_ACTION_94' | 'GENERIC_ACTION_95' | 'GENERIC_ACTION_96' | 'GENERIC_ACTION_97' | 'GENERIC_ACTION_98' | 'GENERIC_ACTION_99' | 'THEME_GENERIC_ACTION_1' | 'THEME_GENERIC_ACTION_10' | 'THEME_GENERIC_ACTION_11' | 'THEME_GENERIC_ACTION_12' | 'THEME_GENERIC_ACTION_13' | 'THEME_GENERIC_ACTION_14' | 'THEME_GENERIC_ACTION_15' | 'THEME_GENERIC_ACTION_16' | 'THEME_GENERIC_ACTION_17' | 'THEME_GENERIC_ACTION_18' | 'THEME_GENERIC_ACTION_19' | 'THEME_GENERIC_ACTION_2' | 'THEME_GENERIC_ACTION_20' | 'THEME_GENERIC_ACTION_21' | 'THEME_GENERIC_ACTION_22' | 'THEME_GENERIC_ACTION_23' | 'THEME_GENERIC_ACTION_24' | 'THEME_GENERIC_ACTION_25' | 'THEME_GENERIC_ACTION_26' | 'THEME_GENERIC_ACTION_27' | 'THEME_GENERIC_ACTION_28' | 'THEME_GENERIC_ACTION_29' | 'THEME_GENERIC_ACTION_3' | 'THEME_GENERIC_ACTION_30' | 'THEME_GENERIC_ACTION_4' | 'THEME_GENERIC_ACTION_5' | 'THEME_GENERIC_ACTION_6' | 'THEME_GENERIC_ACTION_7' | 'THEME_GENERIC_ACTION_8' | 'THEME_GENERIC_ACTION_9', required - `approve_high_quality` boolean, required - `approve_low_quality` boolean, required - `transition_period_milliseconds` integer, required - `transition_rule_id` string, required - `incentive_id` string, required - `is_published` boolean, required - `labels` CampaignLabelResponse[], required - `name` string - `type` 'DATA' | 'PROGRAM' - `last_published_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `name` string, required - `parent_version` integer, nullable, required - `pause_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `program_label` string, required - `program_type` string, required - `start_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `state` 'ARCHIVED' | 'ENDED' | 'LIVE' | 'NOT_LAUNCHED' | 'PAUSED' | 'STOPPED', required - `steps` CampaignStepResponse[], required - union - object — Stored campaign controller definition. Fields `enabled`, `name`, `scope`, `enabled_on_states`, `selectors`, `aliases`, `journey_names`, `send_policy`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `data` StepDataResponse[], required - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `default_value` union, required — The default value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal default value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `dimension` union, required — The dimension as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal dimension - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `key_type` union, required — The key type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'NONE' | 'PARTNER_EVENT_KEY' | 'PARTNER_PROFILE_KEY' | 'UNIQUE_PARTNER_EVENT_KEY' | 'VALUE' — Literal key type - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `persist_types` union, required — The persist types as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal persist types - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `scope` union, required — The scope as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CLIENT' | 'PRIVATE' | 'PUBLIC' — Literal scope - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `value` union, required — The value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `step_builder` union, required — The step builder as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal step builder - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - string — Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - `triggers` CampaignControllerTriggerResponse[], required - union — Stored campaign controller trigger definition. Fields `trigger_phase`, `trigger_name`, `parent_trigger_group_name`, `trigger_description`, `enabled`, and `negated` are unevaluated and appear in buildtime-evaluatable form. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `type` 'CONTROLLER', required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `actions` CampaignControllerActionResponse[], required - union — Stored campaign controller action definition. Field `enabled` is unevaluated and appears in buildtime-evaluatable form. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `aliases` union, required — The aliases as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal aliases - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `controller_id` string, required - `enabled_on_states` union, required — The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal enabled on states - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `journey_names` union, required — The journey names as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal journey names - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `scope` union, required — The scope as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CLIENT' | 'PRIVATE' | 'PUBLIC' — Literal scope - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `selectors` union, required — The selectors as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal selectors - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `send_policy` union, required — The send policy as configured: a literal value, or an expression (type:string) when defined dynamically. - 'ALL' | 'FIRST_ONLY' — Literal send policy - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - object — Stored campaign frontend controller definition. Fields `enabled`, `name`, `scope`, `enabled_on_states`, `category`, `aliases`, `journey_names`, `send_policy`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `data` StepDataResponse[], required - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `default_value` union, required — The default value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal default value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `dimension` union, required — The dimension as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal dimension - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `key_type` union, required — The key type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'NONE' | 'PARTNER_EVENT_KEY' | 'PARTNER_PROFILE_KEY' | 'UNIQUE_PARTNER_EVENT_KEY' | 'VALUE' — Literal key type - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `persist_types` union, required — The persist types as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal persist types - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `scope` union, required — The scope as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CLIENT' | 'PRIVATE' | 'PUBLIC' — Literal scope - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `value` union, required — The value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `step_builder` union, required — The step builder as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal step builder - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - string — Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - `triggers` CampaignControllerTriggerResponse[], required - union — Stored campaign controller trigger definition. Fields `trigger_phase`, `trigger_name`, `parent_trigger_group_name`, `trigger_description`, `enabled`, and `negated` are unevaluated and appear in buildtime-evaluatable form. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `type` 'FRONTEND_CONTROLLER', required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `actions` CampaignControllerActionResponse[], required - union — Stored campaign controller action definition. Field `enabled` is unevaluated and appears in buildtime-evaluatable form. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `aliases` union, required — The aliases as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal aliases - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `category` union, required — The category as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `enabled_on_states` union, required — The enabled on states as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal enabled on states - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `journey_names` union, required — The journey names as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal journey names - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `scope` union, required — The scope as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CLIENT' | 'PRIVATE' | 'PUBLIC' — Literal scope - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `send_policy` union, required — The send policy as configured: a literal value, or an expression (type:string) when defined dynamically. - 'ALL' | 'FIRST_ONLY' — Literal send policy - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - object — Stored campaign journey entry definition. Fields `enabled`, `journey_name`, `priority`, and `step_builder` are unevaluated and appear in buildtime-evaluatable form. - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `data` StepDataResponse[], required - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `default_value` union, required — The default value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal default value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `dimension` union, required — The dimension as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal dimension - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `key_type` union, required — The key type as configured: a literal value, or an expression (type:string) when defined dynamically. - 'NONE' | 'PARTNER_EVENT_KEY' | 'PARTNER_PROFILE_KEY' | 'UNIQUE_PARTNER_EVENT_KEY' | 'VALUE' — Literal key type - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `name` union, required — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `persist_types` union, required — The persist types as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal persist types - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `scope` union, required — The scope as configured: a literal value, or an expression (type:string) when defined dynamically. - 'CLIENT' | 'PRIVATE' | 'PUBLIC' — Literal scope - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `value` union, required — The value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - string — Javascript expression with [StepDataContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/data/StepDataContext.d.ts). - `enabled` union, required — The enabled as configured: a literal value, or an expression (type:string) when defined dynamically. - boolean — Literal enabled - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `id` string, required - `step_builder` union, required — The step builder as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal step builder - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - string — Javascript expression with [StepBuilderContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/builder/StepBuilderContext.d.ts). - `triggers` CampaignControllerTriggerResponse[], required - union — Stored campaign controller trigger definition. Fields `trigger_phase`, `trigger_name`, `parent_trigger_group_name`, `trigger_description`, `enabled`, and `negated` are unevaluated and appear in buildtime-evaluatable form. - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - object - … - `type` 'JOURNEY_ENTRY', required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `journey_name` union, required — The journey name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `key` JourneyKeyResponse, required - `name` union — The name as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `value` union — The value as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal value - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). - string — Javascript expression with [JourneyKeyContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/step/journey/JourneyKeyContext.d.ts). - `priority` union, required — The priority as configured: a literal value, or an expression (type:string) when defined dynamically. - object — Literal priority - `size` integer - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `stop_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `tags` string[], required - `theme_name` string, required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `variant_selector` union, required — The variant selector as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Handlebars expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). - string — Javascript expression with [VariantSelectionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/VariantSelectionContext.d.ts). - `variants` union, required — The variants as configured: a literal value, or an expression (type:string) when defined dynamically. - string[] — Literal variants - string — Handlebars expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - string — Javascript expression with [CampaignBuildtimeContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/campaign/CampaignBuildtimeContext.d.ts). - `version` integer, required ## Other responses - `400` — Bad Request - `401` — Unauthorized - `402` — Payment Required - `403` — Forbidden - `415` — Unsupported Media Type - `429` — Too Many Requests --- [API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/versions/c16e62e66755/schema)