{ "openapi" : "3.0.1", "info" : { "title" : "Retrieve & filter Action Campaigns", "description" : "Retrieve & filter Action Campaigns", "version" : "v1.79" }, "servers" : [ { "url" : "https://platform-int.adobe.io/journey/campaigns", "description" : "QA" }, { "url" : "https://platform-stage.adobe.io/journey/campaigns", "description" : "Stage" }, { "url" : "https://platform.adobe.io/journey/campaigns", "description" : "Prod" } ], "security" : [ { }, { "x-api-key" : [ "read", "write" ] } ], "tags" : [ { "name" : "Metadata Resource", "description" : "Metadata collection" }, { "name" : "Workflow Resource", "description" : "Workflow collection" }, { "name" : "Campaign Resource", "description" : "Campaign management resource" } ], "paths" : { "/service/campaigns/{campaignId}/messages/{messageId}/{channel}/variants/{variantId}" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Get campaign message or variant", "operationId" : "getCampaignMessageOrVariant", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "messageId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Get campaigns", "operationId" : "getCampaigns", "parameters" : [ { "name" : "count", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "example" : 50 }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "name" }, "example" : "name" }, { "name" : "property", "in" : "query", "required" : false, "schema" : { "type" : "string" }, "example" : "campaignClass!=inline;name=like=\"my campaign name\"" }, { "name" : "full", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "actions", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : true } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Multi Response Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns/{campaignId}/versions" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Fetching the campaign versions", "operationId" : "getCampaignVersions", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 50 } }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "name" } }, { "name" : "property", "in" : "query", "required" : false, "schema" : { "type" : "string" }, "example" : "name=like=ajo,application_id==12312" }, { "name" : "full", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "actions", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : true } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Multi Response Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns/{campaignId}" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Get campaign details", "operationId" : "getCampaign", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Model" } } } }, "404" : { "description" : "Requested object not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/workflows/{workflowId}" : { "get" : { "tags" : [ "Workflow Resource" ], "summary" : "Get workflow", "operationId" : "getWorkflow", "parameters" : [ { "name" : "workflowId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Workflow Model" } } } }, "404" : { "description" : "Requested object not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/metadata/surfaces" : { "get" : { "tags" : [ "Metadata Resource" ], "summary" : "Get Surfaces", "operationId" : "getSurfaces", "parameters" : [ { "name" : "count", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "example" : 50 }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "surfaceName" }, "example" : "surfaceName" }, { "name" : "channel", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "inapp" }, "example" : "channel=inapp" }, { "name" : "property", "in" : "query", "required" : false, "schema" : { "type" : "string" }, "example" : "surfaceName==ajo;created_at>2021-09-28" }, { "name" : "type", "in" : "query", "required" : false, "schema" : { "type" : "string", "enum" : [ "appConfigurationId", "channelConfigurationId", "surfaceId", "brandingPresetId" ] }, "example" : "type=surfaceId" }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Multi Response Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/metadata/surfaces/{channel}/{surfaceId}" : { "get" : { "tags" : [ "Metadata Resource" ], "summary" : "Get surface details", "operationId" : "getSurface", "parameters" : [ { "name" : "channel", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "surfaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "type", "in" : "query", "required" : false, "schema" : { "type" : "string" }, "example" : "type=surfaceId" }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "404" : { "description" : "Requested object not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Surface" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns/{campaignId}/publish/validation" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "The campaign publishing validation", "operationId" : "getCampaignPublishingNotifications", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "count", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 50 }, "example" : 50 }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "orderby", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "type" }, "example" : "type" }, { "name" : "property", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Multi Response Model" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns/{campaignId}/packages/{packageId}" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Get campaign package details", "operationId" : "getCampaignPackage", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "packageId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "403" : { "description" : "Permission Denied", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "404" : { "description" : "Requested object not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "500" : { "description" : "Any error encountered while retrieving details", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign Notification Model" } } } }, "200" : { "description" : "Request successful", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Package" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } }, "/service/campaigns/{campaignId}/messages/{messageId}" : { "get" : { "tags" : [ "Campaign Resource" ], "summary" : "Get campaign message or variant", "operationId" : "getCampaignMessageOrVariant_1", "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "messageId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "x-gw-ims-org-id", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "IMS Org ID" } }, { "name" : "x-sandbox-name", "in" : "header", "required" : true, "schema" : { "type" : "string", "description" : "Sandbox Name" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } }, "security" : [ { "x-api-key" : [ ] }, { "AdobeUserToken" : [ ] } ] } } }, "components" : { "schemas" : { "Attribute Model" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "messagePublicationIds" : { "type" : "array", "items" : { "type" : "string" } }, "personalization" : { "type" : "boolean" }, "usage" : { "$ref" : "#/components/schemas/Usage model" } }, "description" : "Unified Decisioning Service attributes" }, "Attributes Map Model" : { "type" : "object", "properties" : { "profile" : { "type" : "array", "description" : "Message Service profile attributes", "items" : { "$ref" : "#/components/schemas/Attribute Model" } }, "context" : { "type" : "array", "description" : "Message Service context attributes", "items" : { "$ref" : "#/components/schemas/Attribute Model" } }, "target" : { "type" : "array", "description" : "Message Service target attributes", "items" : { "$ref" : "#/components/schemas/Attribute Model" } }, "audience" : { "type" : "array", "description" : "Campaign audience attributes", "items" : { "$ref" : "#/components/schemas/Attribute Model" } }, "unifiedDecisioning" : { "type" : "array", "description" : "Unified Decisioning Service attributes", "items" : { "$ref" : "#/components/schemas/Attribute Model" } }, "pesLinks" : { "$ref" : "#/components/schemas/Pes Details Model" }, "publicationPesDetails" : { "type" : "array", "description" : "PES Details by Publication (No Save)", "items" : { "$ref" : "#/components/schemas/Message Pes Details Model" } } } }, "Attributes Model" : { "type" : "object", "properties" : { "sendTimeOptimization" : { "type" : "boolean", "description" : "push, email channels only, filterable" }, "burstSpeed" : { "type" : "boolean", "description" : "push channel only, filterable" }, "inboundSchedule" : { "$ref" : "#/components/schemas/Inbound schedule" }, "trigger" : { "$ref" : "#/components/schemas/Trigger Model" }, "ruleSetId" : { "type" : "string", "description" : "rule set id, filterable" }, "surface" : { "$ref" : "#/components/schemas/Package surface" }, "trackingOptions" : { "$ref" : "#/components/schemas/Content Tracking Options" }, "ipWarmup" : { "type" : "boolean", "description" : "email channel only, filterable" }, "sendTimeFor" : { "type" : "string", "description" : "push, email channels only, filterable" }, "sendTimeWithin" : { "type" : "integer", "description" : "send time within, push, email channels only, filterable", "format" : "int32" }, "outboundTrigger" : { "$ref" : "#/components/schemas/Outbound trigger" } }, "description" : "filterable" }, "Campaign Metadata" : { "required" : [ "isTestExecution" ], "type" : "object", "properties" : { "sourceType" : { "type" : "string", "description" : "sortable, filterable", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceName" : { "type" : "string" }, "sourceId" : { "type" : "string", "description" : "sortable, filterable" }, "sourceVersionId" : { "type" : "string", "description" : "sortable, filterable" }, "sourceActionId" : { "type" : "string", "description" : "sortable, filterable" }, "batchInstanceId" : { "type" : "string", "description" : "sortable, filterable" }, "isTestExecution" : { "type" : "boolean", "description" : "sortable, filterable" } }, "description" : "sortable, filterable" }, "Campaign Model" : { "type" : "object", "properties" : { "campaignId" : { "type" : "string", "description" : "filterable", "readOnly" : true }, "versionId" : { "type" : "string", "description" : "filterable", "readOnly" : true }, "draftVersionId" : { "type" : "string", "readOnly" : true }, "liveVersionId" : { "type" : "string", "readOnly" : true }, "name" : { "type" : "string", "description" : "sortable, filterable" }, "description" : { "type" : "string", "description" : "sortable" }, "status" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "schedule" : { "$ref" : "#/components/schemas/Campaigns schedule" }, "createdBy" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "createdByName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "createdAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "modifiedBy" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "modifiedByName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "modifiedAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "publishedBy" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "publishedByName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "publishedAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "firstPublishedAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "completedAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "displayStartDate" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "displayEndDate" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "labelObjects" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Campaign label" } }, "tags" : { "type" : "array", "description" : "filterable", "items" : { "type" : "string", "description" : "filterable" } }, "parentFolderId" : { "type" : "string", "description" : "filterable" }, "type" : { "type" : "string", "description" : "sortable, filterable", "deprecated" : true, "enum" : [ "Marketing", "Transactional" ] }, "campaignType" : { "title" : "Campaign type", "type" : "string", "description" : "sortable, filterable", "enum" : [ "Scheduled", "ApiTriggered", "IpWarmup" ] }, "category" : { "title" : "Campaign category", "type" : "string", "description" : "sortable, filterable", "enum" : [ "Marketing", "Transactional" ] }, "highThroughputMode" : { "type" : "boolean", "description" : "For headless (api triggered transactional) campaigns only,sortable, filterable" }, "campaignClass" : { "type" : "string", "description" : "sortable, filterable", "enum" : [ "regular", "inline" ] }, "enableWebhooks" : { "type" : "boolean", "description" : "filterable" }, "ranking" : { "$ref" : "#/components/schemas/Campaign ranking" }, "identityNamespace" : { "type" : "string", "description" : "sortable, filterable" }, "audience" : { "$ref" : "#/components/schemas/Campaign audience" }, "createNewProfile" : { "type" : "boolean", "description" : "For headless (api triggered) campaigns only, sortable, filterable", "readOnly" : true }, "selectionStrategy" : { "$ref" : "#/components/schemas/Selection Strategy Model" }, "objectives" : { "type" : "array", "description" : "filterable", "items" : { "type" : "string", "description" : "filterable", "enum" : [ "email_click", "email_open" ] }, "enum" : [ "email_click", "email_open" ] }, "languageSettingId" : { "type" : "string", "description" : "Language setting id, filterable" }, "priority" : { "type" : "integer", "format" : "int32" }, "filter" : { "type" : "string", "description" : "string for filtering channel-configs, filterable" }, "targets" : { "$ref" : "#/components/schemas/Targets" }, "throttleRatePerSec" : { "type" : "integer", "description" : "throttle rate control per second, filterable, sortable", "format" : "int64" }, "packages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Package" } }, "metadata" : { "$ref" : "#/components/schemas/Campaign Metadata" }, "actions" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Campaign action" } }, "decisionPolicies" : { "type" : "array", "description" : "List of decision policy refs", "items" : { "$ref" : "#/components/schemas/Decision Policy Ref" } }, "attributes" : { "$ref" : "#/components/schemas/Attributes Map Model" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "Campaign action" : { "type" : "object", "properties" : { "actionType" : { "type" : "string", "readOnly" : true, "enum" : [ "DUPLICATE", "CREATE_DRAFT", "MODIFY", "STOP", "PUBLISH", "ARCHIVE", "DELETE", "RESUME", "EDIT_TAGS" ] }, "actionName" : { "type" : "string", "readOnly" : true }, "available" : { "type" : "boolean", "readOnly" : true } } }, "Campaign audience" : { "type" : "object", "properties" : { "audienceId" : { "type" : "string" }, "audienceType" : { "type" : "string", "nullable" : true, "enum" : [ "all", "external", "targeted", "batchJourney", "orchestratedCampaign", "ajoB2bAccount", "ajoB2bLead" ] } } }, "Campaign label" : { "type" : "object", "properties" : { "labelId" : { "type" : "string", "readOnly" : true }, "labelName" : { "type" : "string", "readOnly" : true }, "labelCategory" : { "type" : "string", "readOnly" : true } }, "readOnly" : true }, "Campaign ranking" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "simple", "algorithmic" ] }, "value" : { "type" : "string", "description" : "simple: LOW/MEDIUM/HIGH, algorithmic: 0..1", "enum" : [ "LOW/MEDIUM/HIGH/0/0.5/1" ] } }, "description" : "sortable, filterable" }, "Campaigns schedule" : { "title" : "Campaigns schedule", "type" : "object", "properties" : { "startDate" : { "type" : "string", "description" : "sortable, filterable" }, "startDateEnabled" : { "type" : "boolean", "description" : "sortable, filterable" }, "endDate" : { "type" : "string", "description" : "sortable, filterable" }, "endDateEnabled" : { "type" : "boolean", "description" : "sortable, filterable" } } }, "Consent model" : { "type" : "object", "properties" : { "filter" : { "type" : "boolean" } } }, "Content Context" : { "type" : "object", "properties" : { "channelId" : { "type" : "string" }, "channelVersion" : { "type" : "string" } } }, "Content Tracking Options" : { "type" : "object", "properties" : { "openTrackingEnabled" : { "type" : "boolean", "description" : "filterable" }, "clickTrackingEnabled" : { "type" : "boolean", "description" : "filterable" } } }, "Content model" : { "type" : "object", "properties" : { "personalization" : { "type" : "boolean" } } }, "Decision Policy Ref" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "MESSAGE", "CONTENT" ] }, "entityIds" : { "type" : "array", "items" : { "type" : "string" } }, "monitoredValue" : { "type" : "string" } }, "description" : "List of decision policy refs" }, "Decision policy and placement model" : { "type" : "object", "properties" : { "decisionPolicyId" : { "type" : "string" }, "placementName" : { "type" : "string" } } }, "DecisionNode" : { "type" : "object", "properties" : { "decisionNodeId" : { "type" : "string" } } }, "Dispatch model" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "items" : { "type" : "string" } } } }, "Experience Decisioning Message Model" : { "type" : "object", "properties" : { "decisionPolicies" : { "type" : "array", "items" : { "type" : "string" } }, "decisionPolicyPlacements" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Decision policy and placement model" } } } }, "Experimentation Spec Model" : { "type" : "object", "properties" : { "experimentId" : { "type" : "string", "description" : "filterable", "readOnly" : true }, "winnerTreatmentId" : { "type" : "string", "description" : "filterable" } }, "description" : "filterable" }, "Frequency Model" : { "title" : "Frequency Model", "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "daily", "weekly", "monthly" ] }, "hour" : { "type" : "integer", "description" : "hour of day: 1-12", "format" : "int64" }, "minute" : { "type" : "integer", "description" : "minutes of hour: 0-59", "format" : "int64" }, "midday" : { "type" : "string", "description" : "Before or after midday: AM/PM", "enum" : [ "am", "pm" ] }, "daysOfMonth" : { "type" : "array", "description" : "day of month for monthly (1-31)", "items" : { "type" : "integer", "description" : "day of month for monthly (1-31)", "format" : "int32" } }, "daysOfWeek" : { "type" : "array", "description" : "day of week for weekly (sunday, monday, tuesday, wednesday, thursday, friday, saturday)", "items" : { "type" : "string", "description" : "day of week for weekly (sunday, monday, tuesday, wednesday, thursday, friday, saturday)" } }, "interval" : { "type" : "integer", "description" : "Frequency interval", "format" : "int32" } }, "description" : "for 'recurring' only" }, "Inbound schedule" : { "title" : "Inbound schedule", "type" : "object", "properties" : { "range" : { "$ref" : "#/components/schemas/Campaigns schedule" } }, "description" : "inapp channel only" }, "Link details" : { "type" : "object", "properties" : { "href" : { "type" : "string" }, "type" : { "type" : "string" }, "templated" : { "type" : "boolean" }, "method" : { "type" : "string" }, "title" : { "type" : "string" }, "hrefLang" : { "type" : "string" } } }, "Message Pes Details Model" : { "required" : [ "pesDetailsEmpty" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "pesDetails" : { "$ref" : "#/components/schemas/Pes Details Model" }, "pesDetailsEmpty" : { "type" : "boolean" } }, "description" : "PES Details by Publication (No Save)" }, "MessageExecutionResumeSpec" : { "type" : "object", "properties" : { "executionId" : { "type" : "string", "description" : "resume executionId for onetime stopped campaign", "readOnly" : true }, "resumableUntil" : { "type" : "string", "description" : "resume time window in zone offset format", "readOnly" : true } }, "description" : "resume spec for onetime stopped campaign", "readOnly" : true }, "Offer model" : { "type" : "object", "properties" : { "personalization" : { "type" : "boolean" }, "rules" : { "type" : "boolean" } } }, "Outbound trigger" : { "title" : "Outbound trigger", "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "once, recurring, cron, now; filterable" }, "startAt" : { "type" : "string", "description" : "for 'recurring','cron'" }, "endAt" : { "type" : "string", "description" : "for 'recurring','cron'" }, "executeAt" : { "type" : "string", "description" : "for 'once' only" }, "timezone" : { "type" : "string", "description" : "for 'recurring', 'cron'; default 'GMT'" }, "userTimezone" : { "type" : "boolean", "description" : "default 'false'" }, "expression" : { "type" : "string", "description" : "for 'cron' only" }, "frequency" : { "$ref" : "#/components/schemas/Frequency Model" }, "frequencies" : { "type" : "array", "description" : "for 'recurring' only", "items" : { "$ref" : "#/components/schemas/Frequency Model" } }, "waves" : { "$ref" : "#/components/schemas/Outbound wave schedule model" }, "occurrences" : { "type" : "integer", "description" : "maximum number of executions for this recurring trigger", "format" : "int32" } }, "description" : "push, email, sms channels only" }, "Outbound wave schedule model" : { "title" : "Outbound wave schedule model", "type" : "object", "properties" : { "distributionType" : { "type" : "string", "description" : "enum: PERCENT|NUMBER", "enum" : [ "PERCENT", "NUMBER" ] }, "customDistribution" : { "type" : "boolean", "description" : "boolean" }, "slices" : { "type" : "array", "description" : "wave slices array", "items" : { "$ref" : "#/components/schemas/Wave Schedule Slice" } }, "schedulingMode" : { "type" : "string", "description" : "enum: SCHEDULED|INTERVAL", "enum" : [ "SCHEDULED", "INTERVAL" ] }, "interval" : { "$ref" : "#/components/schemas/Wave Schedule Interval" } }, "description" : "wave scheduling details" }, "Package" : { "type" : "object", "properties" : { "packageId" : { "type" : "string", "description" : "filterable" }, "packageName" : { "type" : "string", "description" : "filterable" }, "status" : { "title" : "Package status", "type" : "string", "description" : "filterable", "readOnly" : true, "enum" : [ "DRAFT", "PROCESSING", "SCHEDULED", "IN_PROGRESS", "LIVE", "DELETED", "COMPLETED", "STOPPED", "ARCHIVED", "FAILED" ] }, "channel" : { "type" : "string", "description" : "filterable" }, "channelContext" : { "$ref" : "#/components/schemas/Content Context" }, "enabled" : { "type" : "boolean", "description" : "filterable" }, "languageSettingId" : { "type" : "string", "description" : "Language setting id, filterable" }, "messages" : { "type" : "array", "description" : "required for inapp only", "items" : { "$ref" : "#/components/schemas/Package message" } }, "attributes" : { "$ref" : "#/components/schemas/Attributes Model" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true }, "execution" : { "$ref" : "#/components/schemas/Package execution results" } } }, "Package execution results" : { "type" : "object", "properties" : { "executionId" : { "type" : "string", "readOnly" : true }, "resumeSpec" : { "$ref" : "#/components/schemas/MessageExecutionResumeSpec" }, "type" : { "type" : "string", "readOnly" : true, "enum" : [ "IAS", "SCHEDULER" ] } }, "readOnly" : true }, "Package message" : { "type" : "object", "properties" : { "messageId" : { "type" : "string" }, "treatmentId" : { "type" : "string" }, "execution" : { "$ref" : "#/components/schemas/Package message execution results" }, "messageAttributes" : { "$ref" : "#/components/schemas/Experience Decisioning Message Model" }, "decisionPolicyVariantId" : { "type" : "string" }, "decisionNodes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DecisionNode" } }, "decisionNodeId" : { "type" : "string" } }, "description" : "required for inapp only" }, "Package message execution results" : { "type" : "object", "properties" : { "messagePublicationId" : { "type" : "string", "readOnly" : true } }, "readOnly" : true }, "Package surface" : { "type" : "object", "properties" : { "surfaceId" : { "type" : "string", "description" : "filterable" }, "surfaceType" : { "type" : "string", "description" : "Enum: appConfigurationId, brandingPresetId, uri; filterable" } } }, "Pes Details Model" : { "required" : [ "empty" ], "type" : "object", "properties" : { "options" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Pes option" } }, "parents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Pes parent" } }, "enforcementRefs" : { "type" : "array", "items" : { "type" : "string" } }, "empty" : { "type" : "boolean" } } }, "Pes option" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "contentType" : { "type" : "string" }, "schemaPath" : { "type" : "string" } } }, "Pes parent" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "namespace" : { "type" : "string" } } }, "Selection Strategy Model" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Set to false to turn it on or off, sortable, filterable" }, "type" : { "type" : "string", "description" : "sortable, filterable", "enum" : [ "experimentation" ] }, "on" : { "type" : "string", "description" : "sortable, filterable", "enum" : [ "message" ] }, "experimentationSpec" : { "$ref" : "#/components/schemas/Experimentation Spec Model" } }, "description" : "sortable, filterable" }, "Targets" : { "type" : "object", "properties" : { "targetId" : { "type" : "string", "readOnly" : true }, "secondarySchemaId" : { "type" : "string", "readOnly" : true } }, "description" : "Object used to generate query parameters for fetching presets of orchestrated campaigns, filterable" }, "Trigger Condition" : { "title" : "Trigger Condition", "type" : "object", "properties" : { "definition" : { "$ref" : "#/components/schemas/Trigger Condition Definition" }, "type" : { "type" : "string" } } }, "Trigger Condition Definition" : { "title" : "Trigger Condition Definition", "type" : "object", "properties" : { "conditions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Trigger Condition" } }, "searchType" : { "type" : "string" }, "logic" : { "type" : "string" }, "events" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "key" : { "type" : "string" }, "matcher" : { "type" : "string" }, "value" : { "type" : "integer", "format" : "int64" }, "values" : { "type" : "array", "items" : { "type" : "object" } }, "from" : { "type" : "integer", "description" : "epoch mili", "format" : "int64" }, "to" : { "type" : "integer", "description" : "epoch mili", "format" : "int64" } } }, "Trigger Model" : { "title" : "Trigger Model", "type" : "object", "properties" : { "rules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Trigger Rule" } }, "version" : { "type" : "integer", "format" : "int32" } }, "description" : "inapp channel only" }, "Trigger Rule" : { "title" : "Trigger Rule", "type" : "object", "properties" : { "meta" : { "$ref" : "#/components/schemas/Trigger rule metadata" }, "condition" : { "$ref" : "#/components/schemas/Trigger Condition" } } }, "Trigger rule metadata" : { "title" : "Trigger rule metadata", "type" : "object", "properties" : { "ruleType" : { "type" : "string" } } }, "Usage model" : { "type" : "object", "properties" : { "content" : { "$ref" : "#/components/schemas/Content model" }, "offer" : { "$ref" : "#/components/schemas/Offer model" }, "dispatch" : { "$ref" : "#/components/schemas/Dispatch model" }, "consent" : { "$ref" : "#/components/schemas/Consent model" } } }, "Wave Schedule Interval" : { "title" : "Wave Schedule Interval", "required" : [ "days", "hours", "minutes" ], "type" : "object", "properties" : { "days" : { "type" : "integer", "description" : "integer", "format" : "int32" }, "hours" : { "type" : "integer", "description" : "integer", "format" : "int32" }, "minutes" : { "type" : "integer", "description" : "integer", "format" : "int32" } }, "description" : "Wave schedule interval" }, "Wave Schedule Slice" : { "title" : "Wave Schedule Slice", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "string" }, "label" : { "type" : "string", "description" : "Slice label" }, "size" : { "type" : "integer", "description" : "can be percent or number based on distributionType", "format" : "int64" }, "scheduledAt" : { "type" : "string", "description" : "scheduled date time in ISO 8601 format" } }, "description" : "wave slices array" }, "Campaign Error Chain" : { "type" : "object", "properties" : { "serviceId" : { "type" : "string" }, "errorCode" : { "type" : "string" }, "invokingServiceId" : { "type" : "string" }, "unixTimeStampMs" : { "type" : "integer", "format" : "int64" } }, "readOnly" : true }, "Campaign Notification Additional Context" : { "type" : "object", "properties" : { "source" : { "type" : "string" }, "sourceId" : { "type" : "string" }, "errorLevel" : { "type" : "string" }, "variantId" : { "type" : "string" }, "channel" : { "type" : "string" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Campaign Notification Model" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "sortable", "readOnly" : true }, "title" : { "type" : "string", "description" : "sortable", "readOnly" : true }, "message" : { "type" : "string", "description" : "sortable", "readOnly" : true }, "status" : { "type" : "integer", "description" : "sortable", "format" : "int32", "readOnly" : true }, "report" : { "$ref" : "#/components/schemas/Campaign Report Model" }, "error-chain" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Campaign Error Chain" } }, "error" : { "$ref" : "#/components/schemas/Error Details" } } }, "Campaign Report Model" : { "type" : "object", "properties" : { "tenantInfo" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "additionalContext" : { "$ref" : "#/components/schemas/Campaign Notification Additional Context" } }, "readOnly" : true }, "Error Details" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "message" : { "type" : "string" }, "detail" : { "type" : "object", "additionalProperties" : { "type" : "object" } } }, "readOnly" : true, "deprecated" : true }, "AdobeIOAuthInfo" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "region" : { "type" : "string" }, "gatewayAuthorizationToken" : { "type" : "string" }, "authorizationWithoutBearer" : { "type" : "string" }, "expiresIn" : { "type" : "string" }, "userEmail" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "xuserToken" : { "type" : "string" }, "clientId" : { "type" : "string" }, "authorizationToken" : { "type" : "string" }, "authorizationScope" : { "type" : "string" }, "xuserScope" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "userId" : { "type" : "string" }, "environment" : { "type" : "string" } } }, "Decision Policy Model" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "sortable" }, "itemSpec" : { "$ref" : "#/components/schemas/ItemSpec Model" }, "reporting" : { "$ref" : "#/components/schemas/Reporting Metrics" }, "decisionNodes" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "eligibilityRule" : { "type" : "string", "description" : "sortable, filterable" }, "transitions" : { "type" : "array", "description" : "sortable, filterable", "items" : { "$ref" : "#/components/schemas/Transition" } }, "itemSelectionStrategies" : { "type" : "array", "description" : "sortable, filterable", "items" : { "$ref" : "#/components/schemas/Decisioning Selection Strategy" } } } }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "Decisioning Selection Strategy" : { "type" : "object", "properties" : { "strategyType" : { "type" : "string", "enum" : [ "MANUAL", "OFFER_DECISIONING", "RANKING", "SELECTION_STRATEGY", "FALLBACK" ] } }, "description" : "sortable, filterable" }, "ItemSpec Model" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "DECISION_ITEM", "MESSAGE", "PRODUCT_REC" ] } } }, "Reporting Metrics" : { "type" : "object", "properties" : { "metrics" : { "type" : "array", "items" : { "type" : "string" } } } }, "Transition" : { "type" : "object", "properties" : { "decisionNodeId" : { "type" : "string", "description" : "sortable, filterable" } }, "description" : "sortable, filterable" }, "Activity Invocation" : { "type" : "object", "properties" : { "id" : { "type" : "string", "readOnly" : true }, "klass" : { "type" : "string", "readOnly" : true }, "name" : { "type" : "string", "readOnly" : true }, "outcome" : { "type" : "string", "readOnly" : true, "enum" : [ "success", "client_error", "service_error", "upstream_error", "unknown" ] }, "exceptionName" : { "type" : "string", "readOnly" : true }, "exceptionMessage" : { "type" : "string", "readOnly" : true }, "duration" : { "type" : "integer", "format" : "int64", "readOnly" : true } }, "readOnly" : true }, "Campaign Notifications" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "errorSource" : { "type" : "string", "enum" : [ "PACKAGE", "VERSION", "MESSAGE", "UPSTREAM", "SOURCE", "SANDBOX", "ACTION", "CAMPAIGN", "MIGRATION_ERROR_SOURCE", "SURFACE", "GOVERNANCE", "EXPERIMENTATION", "ADMIN" ] }, "notifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Campaign Notification Model" } }, "pesLinks" : { "$ref" : "#/components/schemas/Pes Details Model" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "Result Model" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "id" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "ref" : { "type" : "string", "readOnly" : true } }, "readOnly" : true }, "Validation Model" : { "type" : "object", "properties" : { "errorLevel" : { "type" : "string", "enum" : [ "ERROR", "WARNING" ] }, "errorMessage" : { "type" : "string" }, "results" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Campaign Notifications" } } }, "description" : "filterable", "readOnly" : true }, "Workflow Model" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "workflowId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "runId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "state" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "CREATED", "PROCESSING", "PROCESSED", "FAILED" ] }, "domain" : { "type" : "string", "description" : "filterable", "readOnly" : true }, "status" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "COMPLETED", "FAILED", "CANCELED", "TERMINATED", "CONTINUED_AS_NEW", "TIMED_OUT" ] }, "createdBy" : { "type" : "string", "description" : "filterable", "readOnly" : true }, "createdAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "modifiedAt" : { "type" : "string", "description" : "ISO_INSTANT with 6 fractional digits, sortable, filterable", "readOnly" : true }, "startTime" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "executionTime" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "closeTime" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "duration" : { "type" : "integer", "description" : "sortable, filterable", "format" : "int64", "readOnly" : true }, "errorMessage" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "notifications" : { "$ref" : "#/components/schemas/Validation Model" }, "_result" : { "$ref" : "#/components/schemas/Result Model" }, "bulkResult" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Result Model" } }, "activities" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/Activity Invocation" } }, "sourceType" : { "type" : "string", "description" : "sortable, filterable", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "AnalysisWindow" : { "type" : "object", "properties" : { "length" : { "type" : "integer", "format" : "int32" }, "increment" : { "type" : "string" } } }, "AutoScalingPolicy" : { "type" : "object", "properties" : { "fallbackTreatmentId" : { "type" : "string" }, "type" : { "type" : "string" }, "timedSpec" : { "$ref" : "#/components/schemas/TimedSpec" } } }, "DecisionNodeModel" : { "required" : [ "type" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ITEM_SELECTION", "ELIGIBILITY_RULE", "PATH_SELECTION", "EXPERIMENTATION", "TREATMENT" ] }, "itemSelectionStrategies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ItemSelectionStrategyModel" } }, "eligibilityRule" : { "type" : "string" }, "uiModel" : { "type" : "object" }, "transitions" : { "type" : "array", "items" : { "type" : "string" } }, "experimentId" : { "type" : "string" }, "isExperimentEnabled" : { "type" : "boolean" }, "updateExperiment" : { "type" : "boolean" }, "experiment" : { "$ref" : "#/components/schemas/ExperimentModel" }, "treatmentId" : { "type" : "string" }, "isHoldout" : { "type" : "boolean" } } }, "DecisionPolicyModel" : { "required" : [ "rootDecisionNodeId", "type" ], "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "DECISION_ITEM", "DECISION_PATH", "PRODUCT_REC" ] }, "decisionPolicyState" : { "type" : "string", "enum" : [ "CREATED", "TEST", "PUBLISHED", "STOPPED", "COMPLETED", "ARCHIVED", "TEMPLATE" ] }, "schemaUrl" : { "type" : "string" }, "itemCount" : { "type" : "integer", "format" : "int32" }, "rootDecisionNodeId" : { "type" : "string" }, "decisionNodes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DecisionNodeModel" } } } }, "DecisionPolicyRequest" : { "required" : [ "decisionPolicy" ], "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "MESSAGE", "CONTENT" ] }, "entityIds" : { "type" : "array", "items" : { "type" : "string" } }, "decisionPolicy" : { "$ref" : "#/components/schemas/DecisionPolicyModel" } } }, "Delay" : { "type" : "object", "properties" : { "increment" : { "type" : "string" }, "length" : { "type" : "integer", "format" : "int32" } } }, "ExperimentModel" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "AB_N", "MAB", "BYOM" ] }, "allocationType" : { "type" : "string" }, "state" : { "type" : "string" }, "metricId" : { "type" : "string" }, "successMetricId" : { "type" : "string" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Filter" } }, "winner" : { "$ref" : "#/components/schemas/Winner" }, "treatmentScaling" : { "$ref" : "#/components/schemas/TreatmentScaling" }, "treatments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TreatmentModel" } }, "identityNamespace" : { "type" : "string" }, "reportingSpec" : { "$ref" : "#/components/schemas/ReportingSpec" }, "entityUri" : { "type" : "string" }, "version" : { "type" : "string" }, "source" : { "type" : "string" }, "autoScalingPolicy" : { "$ref" : "#/components/schemas/AutoScalingPolicy" } } }, "Filter" : { "type" : "object", "properties" : { "dimensionId" : { "type" : "string" }, "dimensionValue" : { "type" : "string" } } }, "ItemSelectionStrategyModel" : { "type" : "object", "properties" : { "strategies" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectionStrategyModel" } }, "strategyType" : { "type" : "string", "enum" : [ "SELECTION_STRATEGY", "MANUAL", "FALLBACK" ] } } }, "Metric" : { "type" : "object", "properties" : { "metricId" : { "type" : "string" }, "primaryMetric" : { "type" : "boolean" }, "analysisWindow" : { "$ref" : "#/components/schemas/AnalysisWindow" } } }, "ReportingSpec" : { "type" : "object", "properties" : { "metrics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Metric" } } } }, "SelectionStrategyModel" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "version" : { "type" : "string" } } }, "TimedSpec" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "delay" : { "$ref" : "#/components/schemas/Delay" } } }, "TreatmentModel" : { "required" : [ "id", "name", "percentage" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "percentage" : { "type" : "string" }, "treatmentType" : { "type" : "string" }, "isHoldout" : { "type" : "boolean" } } }, "TreatmentScaling" : { "type" : "object", "properties" : { "treatmentId" : { "type" : "string" } } }, "Winner" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "treatmentId" : { "type" : "string" } } }, "Campaign Tag List Model" : { "type" : "object", "properties" : { "tags" : { "type" : "array", "items" : { "type" : "string" } } } }, "Approval Request Model" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "previewUrl" : { "type" : "string" } } }, "Approval Response Model" : { "type" : "object", "properties" : { "campaignId" : { "type" : "string" }, "versionId" : { "type" : "string" }, "status" : { "type" : "string" }, "approvalStatus" : { "type" : "string", "enum" : [ "APPROVED", "REJECTED", "SUBMITTED_FOR_APPROVAL", "CANCELLED", "UNKNOWN" ] } } }, "Manual translation Activate or Update Request" : { "type" : "object", "properties" : { "languageSettingId" : { "type" : "string" }, "authoringVariant" : { "type" : "string" } } }, "Manual translation Deactivate Request" : { "type" : "object", "properties" : { "variantName" : { "type" : "string" } } }, "Campaign Label List Model" : { "type" : "object", "properties" : { "labels" : { "type" : "array", "items" : { "type" : "string" } } } }, "Experiment Filter Model" : { "type" : "object", "properties" : { "dimensionId" : { "type" : "string" }, "dimensionValue" : { "type" : "string" } } }, "Experimentation auto scaling policy model" : { "type" : "object", "properties" : { "fallbackTreatmentId" : { "type" : "string" }, "type" : { "type" : "string" }, "timedSpec" : { "$ref" : "#/components/schemas/Experimentation timed spec model" } } }, "Experimentation scale delay model" : { "type" : "object", "properties" : { "increment" : { "type" : "string" }, "length" : { "type" : "integer", "format" : "int32" } } }, "Experimentation timed spec model" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "delay" : { "$ref" : "#/components/schemas/Experimentation scale delay model" } } }, "Request Experimental Model" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "allocationType" : { "type" : "string" }, "metricId" : { "type" : "string" }, "treatments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Request Treatment Model" } }, "autoScalingPolicy" : { "$ref" : "#/components/schemas/Experimentation auto scaling policy model" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Experiment Filter Model" } }, "reportingSpec" : { "$ref" : "#/components/schemas/Request Experimental Reporting Spec Model" } } }, "Request Experimental Reporting Spec Model" : { "type" : "object", "properties" : { "experimentDimensionId" : { "type" : "string" }, "treatmentDimensionId" : { "type" : "string" } } }, "Request Treatment Model" : { "type" : "object", "properties" : { "sourceTreatmentId" : { "type" : "string" }, "treatmentId" : { "type" : "string" }, "treatmentName" : { "type" : "string" }, "percentage" : { "type" : "string" }, "isHoldout" : { "type" : "boolean" } } }, "Content Direct Mail" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "data" : { "type" : "boolean" } } }, "Content Direct Mail Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "fileName" : { "type" : "string" }, "notes" : { "type" : "string" }, "returnToSender" : { "type" : "boolean" }, "notesPosition" : { "type" : "string" }, "sortBy" : { "type" : "string" }, "attributes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Direct Mail" } } } }, "Content Direct Mail Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Direct Mail Variant" } } } }, "Content Email Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "subject" : { "type" : "string" }, "html" : { "$ref" : "#/components/schemas/Content Html" }, "x-amp-html" : { "$ref" : "#/components/schemas/Content Html" }, "text" : { "$ref" : "#/components/schemas/Content Html" }, "editorContext" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "treatmentId" : { "type" : "string" }, "xampHtml" : { "$ref" : "#/components/schemas/Content Html" } } }, "Content Email Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Email Variant" } } } }, "Content Html" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "syncFromHtml" : { "type" : "boolean" }, "description" : { "type" : "string" } } }, "Content InApp" : { "type" : "object", "properties" : { "inapp" : { "$ref" : "#/components/schemas/Content Inapp Variants" }, "push" : { "$ref" : "#/components/schemas/Content Push Variants" }, "email" : { "$ref" : "#/components/schemas/Content Email Variants" }, "web" : { "$ref" : "#/components/schemas/Content Web Variants" }, "sms" : { "$ref" : "#/components/schemas/Content SMS Variants" }, "directMail" : { "$ref" : "#/components/schemas/Content Direct Mail Variants" }, "messagefeed" : { "$ref" : "#/components/schemas/Content Message Feed Variants" }, "whatsApp" : { "$ref" : "#/components/schemas/Content WhatsApp Variants" } } }, "Content Inapp Variant" : { "required" : [ "content" ], "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "state" : { "type" : "string" }, "content" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Content Inapp Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Inapp Variant" } } } }, "Content Interaction" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "type" : { "type" : "string" } } }, "Content Message Feed Variant Item" : { "type" : "object", "properties" : { "schema" : { "type" : "string" }, "contentObject" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Content Message Feed Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Web Variant" } } } }, "Content Push Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "pushType" : { "type" : "string" }, "title" : { "type" : "string" }, "message" : { "type" : "string" }, "appNames" : { "type" : "array", "items" : { "type" : "string" } }, "ios" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "android" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "treatmentId" : { "type" : "string" } } }, "Content Push Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Push Variant" } } } }, "Content SMS Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "text" : { "type" : "string" }, "treatmentId" : { "type" : "string" } } }, "Content SMS Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content SMS Variant" } } } }, "Content Tracking Info" : { "type" : "object", "properties" : { "interactions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Interaction" } } } }, "Content Web Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "authoringUrl" : { "type" : "string" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Message Feed Variant Item" } }, "trackingInfo" : { "$ref" : "#/components/schemas/Content Tracking Info" } } }, "Content Web Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Web Variant" } } } }, "Content WhatsApp Variant" : { "type" : "object", "properties" : { "variantId" : { "type" : "string" }, "name" : { "type" : "string" }, "whatsAppVariantType" : { "type" : "string" }, "content" : { "$ref" : "#/components/schemas/WhatsApp Content" } } }, "Content WhatsApp Variants" : { "type" : "object", "properties" : { "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content WhatsApp Variant" } } } }, "Request Message Model" : { "type" : "object", "properties" : { "category" : { "type" : "string" }, "brandingPresetId" : { "type" : "string" }, "channels" : { "$ref" : "#/components/schemas/Content InApp" }, "channel" : { "type" : "string" }, "channelContext" : { "$ref" : "#/components/schemas/Content Context" }, "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Content Inapp Variant" } }, "surfaceId" : { "type" : "string" }, "surfaceType" : { "type" : "string" }, "identityNamespace" : { "type" : "string" }, "context" : { "$ref" : "#/components/schemas/Content Context" }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "trackingOptions" : { "$ref" : "#/components/schemas/Content Tracking Options" }, "decisionPoliciesMap" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "description" : "Used for creating a new message for both v1 and v2 content" }, "WhatsApp Content" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "language" : { "type" : "string" }, "templateRef" : { "type" : "string" }, "header" : { "type" : "string" }, "footer" : { "type" : "string" }, "whatsAppTemplateComponent" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WhatsApp Template Component" } } } }, "WhatsApp Template Component" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "parameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WhatsApp Template Parameters" } } } }, "WhatsApp Template Parameters" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "text" : { "type" : "string" } } }, "Abac Permission Request List" : { "type" : "object", "properties" : { "requests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Abac Permissions Request Model" } } } }, "Abac Permissions Request Model" : { "required" : [ "action" ], "type" : "object", "properties" : { "resource" : { "$ref" : "#/components/schemas/Abac Resource Model" }, "action" : { "type" : "string", "enum" : [ "read", "write", "delete", "archive", "reset", "review", "publish", "execute", "export", "import", "copy", "view", "update", "create", "activate", "deactivate", "simulate", "generate", "share", "*" ] } } }, "Abac Resource Model" : { "type" : "object", "properties" : { "campaignId" : { "type" : "string" } }, "readOnly" : true }, "Multi Response Model" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "type" : "object" } }, "_page" : { "$ref" : "#/components/schemas/Page details" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" } } } }, "Page details" : { "type" : "object", "properties" : { "orderby" : { "type" : "string" }, "count" : { "type" : "integer", "format" : "int32" }, "page" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string" }, "totalPages" : { "type" : "integer", "format" : "int32" }, "totalCount" : { "type" : "integer", "format" : "int64" }, "property" : { "type" : "string" }, "start" : { "type" : "string" }, "next" : { "type" : "string" }, "previous" : { "type" : "string" } } }, "Ids validation request for messageIds or campaignIds" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "campaign", "message" ] }, "ids" : { "type" : "array", "items" : { "type" : "string" } }, "pesDetails" : { "type" : "boolean" } } }, "Source Action" : { "type" : "object", "properties" : { "sourceActionId" : { "type" : "string" }, "campaign" : { "$ref" : "#/components/schemas/Source action campaign" } } }, "Source Targets Update Request" : { "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "sourceActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Source Action" } } } }, "Source action campaign" : { "type" : "object", "properties" : { "campaignId" : { "type" : "string" }, "versionId" : { "type" : "string" }, "sourceCampaignId" : { "type" : "string" }, "audience" : { "$ref" : "#/components/schemas/Campaign audience" }, "targets" : { "$ref" : "#/components/schemas/Targets" } } }, "Source Discarding Request" : { "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "sourceActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Source Action" } } } }, "Source Publishing Request" : { "required" : [ "sourceRules", "sourceValidationRules" ], "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "labels" : { "type" : "array", "items" : { "type" : "string" } }, "sourceActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Source publishing action" } }, "sourceValidationRules" : { "$ref" : "#/components/schemas/Source Validation Rules" }, "sourceRules" : { "$ref" : "#/components/schemas/Source Rules" } } }, "Source Rules" : { "required" : [ "distributedPublication" ], "type" : "object", "properties" : { "distributedPublication" : { "type" : "boolean", "description" : "Apply distributed publication", "default" : false } } }, "Source Validation Rules" : { "required" : [ "hasCampaignIdValidation", "hasMessageValidation", "hasUpstreamValidation" ], "type" : "object", "properties" : { "hasMessageValidation" : { "type" : "boolean", "description" : "Flag to indicate if message validation is required", "default" : true }, "hasCampaignIdValidation" : { "type" : "boolean", "description" : "Flag to indicate if campaign id validation is required", "default" : true }, "hasUpstreamValidation" : { "type" : "boolean", "description" : "Flag to indicate if there is the upstream validation required: surface, experiment, IAS, FIs, audience", "default" : true } } }, "Source action default" : { "type" : "object", "properties" : { "priority" : { "type" : "integer", "format" : "int32" }, "identityNamespace" : { "type" : "string" }, "audience" : { "$ref" : "#/components/schemas/Campaign audience" } } }, "Source action message" : { "type" : "object", "properties" : { "category" : { "title" : "Campaign category", "type" : "string", "enum" : [ "Marketing", "Transactional" ] }, "messageId" : { "type" : "string" }, "identityNamespace" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "EMAIL", "INAPP", "PUSH", "SMS", "WEB", "DIRECTMAIL", "API", "CODE", "MESSAGEFEED", "OPEN", "WHATSAPP" ] }, "channelContext" : { "$ref" : "#/components/schemas/Content Context" }, "trackingOptions" : { "$ref" : "#/components/schemas/Content Tracking Options" }, "surface" : { "$ref" : "#/components/schemas/Package surface" }, "audience" : { "$ref" : "#/components/schemas/Campaign audience" }, "inboundTrigger" : { "$ref" : "#/components/schemas/Trigger Model" }, "priority" : { "type" : "integer", "format" : "int32" }, "throttleRatePerSec" : { "type" : "integer", "format" : "int64" } } }, "Source publishing action" : { "required" : [ "isTestExecution" ], "type" : "object", "properties" : { "sourceActionId" : { "type" : "string" }, "campaign" : { "$ref" : "#/components/schemas/Source action campaign" }, "message" : { "$ref" : "#/components/schemas/Source action message" }, "actionDefault" : { "$ref" : "#/components/schemas/Source action default" }, "isTestExecution" : { "type" : "boolean" }, "batchInstanceId" : { "type" : "string" } } }, "SourceLabelsRequest" : { "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "labels" : { "type" : "array", "items" : { "type" : "string" } } } }, "Source Executing Request" : { "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "sourceActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Source Action" } } } }, "Source Duplicate Request" : { "type" : "object", "properties" : { "sourceType" : { "type" : "string", "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "sourceId" : { "type" : "string" }, "sourceVersionId" : { "type" : "string" }, "sourceActions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Source Action" } } } }, "Json Patch Model" : { "type" : "object", "properties" : { "op" : { "type" : "string" }, "path" : { "type" : "string" }, "value" : { "type" : "string" } } }, "Surface" : { "required" : [ "attributes" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "sortable, filterable" }, "type" : { "type" : "string", "readOnly" : true }, "surfaceName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "surfaceChannel" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "surfaceStatus" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "object", "readOnly" : true }, "readOnly" : true }, "createdAt" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "modifiedAt" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "appId" : { "type" : "string" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "Channel" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "sortable, filterable" }, "channelName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true }, "type" : { "type" : "string", "readOnly" : true } } }, "Link" : { "type" : "object", "properties" : { "href" : { "type" : "string" }, "templated" : { "type" : "boolean" } } }, "Links" : { "type" : "object", "properties" : { "self" : { "$ref" : "#/components/schemas/Link" }, "next" : { "$ref" : "#/components/schemas/Link" }, "page" : { "$ref" : "#/components/schemas/Link" } } }, "PageMetadata" : { "type" : "object", "properties" : { "orderBy" : { "type" : "string" }, "start" : { "type" : "string" }, "next" : { "type" : "string" }, "count" : { "type" : "integer", "format" : "int64" }, "totalCount" : { "type" : "integer", "format" : "int64" }, "property" : { "type" : "array", "items" : { "type" : "string" } } } }, "PaginatedResponse" : { "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "type" : "object" } }, "_page" : { "$ref" : "#/components/schemas/PageMetadata" }, "_links" : { "$ref" : "#/components/schemas/Links" } } }, "Approval Actor Response Model" : { "type" : "object", "properties" : { "versionId" : { "type" : "string" }, "isReviewer" : { "type" : "boolean" }, "isSubmitter" : { "type" : "boolean" } } }, "Experiment Model" : { "type" : "object", "properties" : { "experimentId" : { "type" : "string" }, "experimentName" : { "type" : "string" }, "allocationType" : { "type" : "string" }, "successMetricId" : { "type" : "string" }, "winner" : { "$ref" : "#/components/schemas/ExperimentalWinner" }, "filters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Experiment Filter Model" } }, "treatmentScaling" : { "$ref" : "#/components/schemas/ExperimentalTreatmentScaling" }, "treatments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Treatment Model" } }, "state" : { "type" : "string" }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true }, "autoScalingPolicy" : { "$ref" : "#/components/schemas/Experimentation auto scaling policy model" } } }, "ExperimentalTreatmentScaling" : { "type" : "object", "properties" : { "treatmentId" : { "type" : "string" } } }, "ExperimentalWinner" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "treatmentId" : { "type" : "string" } } }, "Treatment Model" : { "type" : "object", "properties" : { "treatmentId" : { "type" : "string" }, "treatmentName" : { "type" : "string" }, "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Treatment channel Model" } }, "isHoldout" : { "type" : "boolean" }, "percentage" : { "type" : "string" } } }, "Treatment channel Model" : { "type" : "object", "properties" : { "channel" : { "type" : "string" }, "messageId" : { "type" : "string" }, "channelContext" : { "$ref" : "#/components/schemas/Content Context" }, "messagePublicationId" : { "type" : "string" } } }, "LoggedAuditModel" : { "required" : [ "permitted" ], "type" : "object", "properties" : { "permissionType" : { "type" : "string" }, "authId" : { "type" : "string" }, "permitted" : { "type" : "boolean" }, "objectId" : { "type" : "string" }, "objectName" : { "type" : "string" }, "securityPermission" : { "type" : "string", "enum" : [ "CAMPAIGN_DELETE", "CAMPAIGN_ARCHIVE", "CAMPAIGN_PUBLISH", "CAMPAIGN_STOP", "CAMPAIGN_READ", "CAMPAIGN_WRITE", "CAMPAIGN_CREATE", "VERIFY_CAMPAIGN_PUBLISH", "VERIFY_CAMPAIGN_READ", "VERIFY_CAMPAIGN_WRITE", "JOURNEY_READ", "JOURNEY_PUBLISH", "JOURNEY_STOP", "JOURNEY_CREATE", "JOURNEY_WRITE", "VERIFY_JOURNEY_PUBLISH", "VERIFY_JOURNEY_WRITE", "REQUEST_APPROVAL", "CANCEL_REQUEST_APPROVAL", "REVIEW", "REVIEW_ACTOR", "ORCHESTRATED_CAMPAIGN_READ", "ORCHESTRATED_CAMPAIGN_PUBLISH", "ORCHESTRATED_CAMPAIGN_STOP", "ORCHESTRATED_CAMPAIGN_CREATE", "ORCHESTRATED_CAMPAIGN_WRITE", "VERIFY_ORCHESTRATED_CAMPAIGN_PUBLISH", "VERIFY_ORCHESTRATED_CAMPAIGN_WRITE" ] } }, "readOnly" : true }, "Tracking Campaign" : { "type" : "object", "properties" : { "campaignId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "versionId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "status" : { "title" : "Status", "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "ACTIVATING", "DRAFT", "IN_REVIEW", "PROCESSING", "SCHEDULED", "LIVE", "DELETED", "COMPLETED", "STOPPING", "STOPPED", "ARCHIVED", "FAILED" ] }, "sourceType" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "campaign", "journey", "ipWarmup", "journeyFragment", "orchestratedCampaign", "b2bAccountJourneys", "smbCampaign" ] }, "channels" : { "type" : "array", "readOnly" : true, "items" : { "type" : "string", "readOnly" : true } }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } }, "description" : "sortable, filterable", "readOnly" : true }, "Tracking Event" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "timestamp" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "trackingGroup" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "CREATE", "PUBLISH", "VALIDATE", "UPDATE", "AUTO_SAVE", "DELETE", "ADMIN" ] }, "trackingType" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "state" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true, "enum" : [ "CREATED", "PROCESSING", "PROCESSED", "FAILED" ] }, "campaign" : { "$ref" : "#/components/schemas/Tracking Campaign" }, "campaignId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "versionId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "userId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "userName" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "imsOrgId" : { "type" : "string", "readOnly" : true }, "sandboxId" : { "type" : "string", "readOnly" : true }, "sandboxName" : { "type" : "string", "readOnly" : true }, "source" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "workflow" : { "$ref" : "#/components/schemas/Tracking Workflow" }, "workflowId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "requestId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "notifications" : { "$ref" : "#/components/schemas/Validation Model" }, "hasPostEvents" : { "type" : "boolean", "readOnly" : true }, "audit" : { "type" : "array", "readOnly" : true, "items" : { "$ref" : "#/components/schemas/LoggedAuditModel" } }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string", "readOnly" : true }, "readOnly" : true }, "_links" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link details" }, "readOnly" : true } } }, "Tracking Workflow" : { "type" : "object", "properties" : { "workflowId" : { "type" : "string", "description" : "sortable, filterable", "readOnly" : true }, "errorActivity" : { "$ref" : "#/components/schemas/Activity Invocation" }, "duration" : { "type" : "integer", "format" : "int64", "readOnly" : true } }, "description" : "filterable", "readOnly" : true }, "Basic Response Model" : { "required" : [ "result" ], "type" : "object", "properties" : { "result" : { "type" : "object", "additionalProperties" : { "type" : "object", "readOnly" : true }, "readOnly" : true } } } }, "securitySchemes" : { "x-api-key" : { "type" : "apiKey", "name" : "x-api-key", "in" : "header" } } } }