{ "openapi": "3.0.1", "info": { "title": "Adobe Target Admin and Reporting APIs", "termsOfService": "https://www.adobe.com/legal/terms.html", "version": "v1.0" }, "servers": [ { "url": "https://mc.adobe.io/", "description": "Adobe.io gateway" } ], "paths": { "/{tenant}/target/properties/{id}": { "get": { "tags": [ "Properties" ], "summary": "Get a property by ID", "description": "Retrieve the current definition of a property referenced by the property ID.", "operationId": "getProperty", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } } } } }, "put": { "tags": [ "Properties" ], "summary": "Update a property by ID", "description": "Update the property referenced by the property ID.", "operationId": "updateProperty", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } } } } }, "delete": { "tags": [ "Properties" ], "summary": "Delete a property by ID", "description": "Delete the property referenced by the property ID.", "operationId": "deleteProperty", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } } } } } }, "/{tenant}/target/offers/recs/{id}": { "get": { "tags": [ "Offers" ], "summary": "Get recs offer by ID", "description": "Retrieves the contents of the Recommendations offer referenced by the provided ID.", "operationId": "getOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } } } } }, "put": { "tags": [ "Offers" ], "summary": "Update a recs offer by ID", "description": "Updates the Recommendations offer referenced by the ID specified in the URL.", "operationId": "updateOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } } } } }, "delete": { "tags": [ "Offers" ], "summary": "Delete a recs offer by ID", "description": "Deletes the Recommendations offer referenced by the provided ID.", "operationId": "deleteOffer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } } } } } }, "/{tenant}/target/offers/json/{id}": { "get": { "tags": [ "Offers" ], "summary": "Get json offer by ID", "description": "Retrieves the contents of the JSON offer referenced by the provided ID.", "operationId": "getOffer_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } } } } }, "put": { "tags": [ "Offers" ], "summary": "Update a json offer by ID", "description": "Updates the JSON offer referenced by the ID specified in the URL.", "operationId": "updateOffer_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } } } } }, "delete": { "tags": [ "Offers" ], "summary": "Delete a json offer by ID", "description": "Deletes the JSON offer referenced by the provided ID.", "operationId": "deleteOffer_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } } } } } }, "/{tenant}/target/offers/content/{id}": { "get": { "tags": [ "Offers" ], "summary": "Get content offer by ID", "description": "Retrieves the contents of the content offer referenced by the provided ID.", "operationId": "getOffer_1_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } } } } }, "put": { "tags": [ "Offers" ], "summary": "Update a content offer by ID", "description": "Updates the content offer referenced by the ID specified in the URL.", "operationId": "updateOffer_1_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } } } } }, "delete": { "tags": [ "Offers" ], "summary": "Delete a content offer by ID", "description": "Deletes the content offer referenced by the provided ID.", "operationId": "deleteOffer_1_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } } } } } }, "/{tenant}/target/hosts/{hostName}": { "put": { "tags": [ "Hosts" ], "summary": "Update host", "description": "Update the host referenced by the environment and host name.", "operationId": "updateHost", "parameters": [ { "name": "hostName", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/HostEnvironment" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/HostEnvironment" } } } } } }, "delete": { "tags": [ "Hosts" ], "summary": "Delete host", "description": "Delete the host referenced by the host name.", "operationId": "deleteHost", "parameters": [ { "name": "hostName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Host" } } } } } } }, "/{tenant}/target/environments/{id}": { "get": { "tags": [ "Environments" ], "summary": "List environment", "description": "Retrieve the current definition of an environment as referenced by the environment ID.", "operationId": "getEnvironment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } } } } }, "put": { "tags": [ "Environments" ], "summary": "Update environment", "description": "Update the environment referenced by the environment ID.", "operationId": "updateEnvironment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } } } } }, "delete": { "tags": [ "Environments" ], "summary": "Delete environment", "description": "Delete the environment referenced by the environment ID.", "operationId": "deleteEnvironment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } } } } } }, "/{tenant}/target/environments/defaults": { "get": { "tags": [ "Environments" ], "summary": "Get default environments", "description": "Retrieve a list of the default environments.", "operationId": "getDefaultEnvironments", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/DefaultEnvironmentsDTO" } } } } } }, "put": { "tags": [ "Environments" ], "summary": "Update default environments", "description": "Update the default environment(s) referenced by the environment ID.", "operationId": "updateDefaultEnvironments", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/DefaultEnvironmentsDTO" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/DefaultEnvironmentsDTO" } } } } } } }, "/{tenant}/target/clients/uisettings": { "get": { "tags": [ "Clients" ], "summary": "Get client UI settings", "description": "Retrieve client UI settings.", "operationId": "getSettings", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/UiSettingsDto" } } } } } }, "put": { "tags": [ "Clients" ], "summary": "Update client UI settings", "description": "Update client UI settings.", "operationId": "updateSettings", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/UiSettingsDto" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/UiSettingsDto" } } } } } } }, "/{tenant}/target/clients/settings": { "get": { "tags": [ "Clients" ], "summary": "Get client settings", "description": "Retrieve client settings.", "operationId": "getSettings_1", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ClientSelfServiceSettings" } } } } } }, "put": { "tags": [ "Clients" ], "summary": "Update client settings", "description": "Update client settings.", "operationId": "updateSettings_1", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ClientSelfServiceSettings" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ClientSelfServiceSettings" } } } } }, "deprecated": true } }, "/{tenant}/target/clients/ipfilter/{type}": { "get": { "tags": [ "Clients" ], "summary": "Get client report IP filters", "description": "Retrieve client report IP filters.", "operationId": "getReportIpFilters", "parameters": [ { "name": "tenantClientCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ADMIN", "REPORT" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/IpFiltersDto" } } } } } }, "put": { "tags": [ "Clients" ], "summary": "Save client report IP filters", "description": "Save client report IP filters.", "operationId": "saveReportIpFilters", "parameters": [ { "name": "tenantClientCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "ADMIN", "REPORT" ] } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IpFilterDTO" } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/IpFiltersDto" } } } } } } }, "/{tenant}/target/authorizedHosts": { "get": { "tags": [ "Hosts" ], "summary": "List authorized hosts", "description": "Retrieve list of hosts that are authorized.", "operationId": "getAuthorizedHosts", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AuthorizedMboxHosts" } } } } } }, "put": { "tags": [ "Hosts" ], "summary": "Update authorized hosts", "description": "Update authorized hosts.", "operationId": "updateAuthorizedHost", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AuthorizedMboxHosts" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AuthorizedMboxHosts" } } } } } } }, "/{tenant}/target/audiences/{id}": { "get": { "tags": [ "Audiences" ], "summary": "Get audience", "description": "Get the audience definition specified by the provided ID.", "operationId": "getAudience_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } } } } }, "put": { "tags": [ "Audiences" ], "summary": "Update audience", "description": "Update an audience with the new rules specified by the request data.", "operationId": "updateAudience_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } } } } }, "delete": { "tags": [ "Audiences" ], "summary": "Delete audience", "description": "Delete the audience referenced by the specified ID.", "operationId": "deleteAudience_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } } } } }, "patch": { "tags": [ "Audiences" ], "summary": "Patch a specific audience by ID", "description": "Partial update to the audience referenced by the specified ID. You can update individual fields like name, description, targetRule, etc.", "operationId": "patchAudience", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/AudiencePatch" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } } } } } } }, "/{tenant}/target/atjs/settings": { "get": { "tags": [ "Atjs" ], "summary": "Get at.js settings", "description": "Retrieve at.js settings.", "operationId": "getAtJsSettings", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ATJSSettings" } } } } } }, "put": { "tags": [ "Atjs" ], "summary": "Update at.js settings", "description": "Update at.js settings.", "operationId": "putATJSSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATJSSettings" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ATJSSettings" } } } } } } }, "/{tenant}/target/activities/{id}/state": { "put": { "tags": [ "Activities" ], "summary": "Update activity state", "description": "Update the state of the activity referenced by the provided ID. Valid values are approved, deactivated, deleted and saved.", "operationId": "updateState", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/State" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/ab/{id}/state": { "put": { "tags": [ "Activities" ], "summary": "Update AB activity state", "description": "Update the state of the AB activity referenced by the provided ID. Valid values are approved, deactivated, deleted and saved.", "operationId": "updateState_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/State" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/xt/{id}/state": { "put": { "tags": [ "Activities" ], "summary": "Update XT activity state", "description": "Update the state of the Experience Targeting activity referenced by the provided ID. Valid values are approved, deactivated, deleted and saved.", "operationId": "updateState_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/State" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/{id}/schedule": { "put": { "tags": [ "Activities" ], "summary": "Update activity schedule", "description": "Update the startsAt and endsAt fields of an activity referenced by the provided ID. This controls when the activity goes live. The schedule defines the start and end date and time for the activity. If successful, it returns a status code 200. In constructing the startsAt and endsAt values, follow ISO 8601 style date-hour formats.", "operationId": "updateSchedule", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/ab/{id}/schedule": { "put": { "tags": [ "Activities" ], "summary": "Update AB activity schedule", "description": "Update the startsAt and endsAt fields of the AB activity referenced by the provided ID.", "operationId": "updateSchedule_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/xt/{id}/schedule": { "put": { "tags": [ "Activities" ], "summary": "Update XT activity schedule", "description": "Update the startsAt and endsAt fields of an Experience Targeting activity.", "operationId": "updateSchedule_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Schedule" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/{id}/priority": { "put": { "tags": [ "Activities" ], "summary": "Change activity priority", "description": "Change the priority of the activity referenced by the provided ID. This will affect the way Target evaluates the activity selection at runtime. Allowed values for priority are 0-999. If you are using low, medium, and high in the Target UI, those correspond to 0, 5, and 10, respectively. You must turn on granular priority in the settings page in order to use the 0-999 scale.", "operationId": "updatePriority", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/ab/{id}/priority": { "put": { "tags": [ "Activities" ], "summary": "Change AB activity priority", "description": "Change the priority of the AB activity referenced by the provided ID.", "operationId": "updatePriority_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/xt/{id}/priority": { "put": { "tags": [ "Activities" ], "summary": "Change XT activity priority", "description": "Change the priority of the Experience Targeting activity referenced by the provided ID.", "operationId": "updatePriority_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/{id}/name": { "put": { "tags": [ "Activities" ], "summary": "Rename activity", "description": "Rename the activity referenced by the provided ID. This change will be reflected in the Target user interface after the next refresh.", "operationId": "updateName", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Name" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/ab/{id}/name": { "put": { "tags": [ "Activities" ], "summary": "Rename AB activity", "description": "Update the name of the AB activity referenced by the provided ID.", "operationId": "updateName_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Name" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/xt/{id}/name": { "put": { "tags": [ "Activities" ], "summary": "Rename XT activity", "description": "Rename the Experience Targeting activity referenced by the provided ID.", "operationId": "updateName_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Name" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityDescription" } } } } } } }, "/{tenant}/target/activities/abt/{id}": { "get": { "tags": [ "Activities" ], "summary": "Get AP activity by ID", "description": "Fetch the current definition of an Automated Personalization activity as referenced by the provided ID.", "operationId": "getActivity_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } } } } }, "put": { "tags": [ "Activities" ], "summary": "Update AP activity", "description": "Update the Automated Personalization activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.\u003cbr/\u003e\u003cb\u003eNote:\u003c/b\u003eCreating auto-target activities is currently not supported through the API.", "operationId": "updateActivity_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete AP activity", "description": "Delete the Automated Personalization activity referenced by the provided ID.", "operationId": "deleteActivity_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } } } } } }, "/{tenant}/target/activities/ab/{id}": { "get": { "tags": [ "Activities" ], "summary": "Get AB activity by ID", "description": "Fetch the current definition of an AB activity as referenced by the provided ID.", "operationId": "getActivity_3_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } }, "put": { "tags": [ "Activities" ], "summary": "Update AB activity", "description": "Update the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", "operationId": "updateActivity_3_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete AB activity", "description": "Delete the AB activity referenced by the provided ID.", "operationId": "deleteActivity_3_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } } }, "/{tenant}/target/activities/xt/{id}": { "get": { "tags": [ "Activities" ], "summary": "Get AB activity by ID", "description": "Fetch the current definition of an AB activity as referenced by the provided ID.", "operationId": "getActivity_2_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } }, "put": { "tags": [ "Activities" ], "summary": "Update AB activity", "description": "Update the AB activity definition with the contents as provided in the request. This can change the state and behaviour of an existing activity.", "operationId": "updateActivity_2_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete AB activity", "description": "Delete the AB activity referenced by the provided ID.", "operationId": "deleteActivity_2_1_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } } }, "/{tenant}/target/responsetokens": { "get": { "tags": [ "Response tokens" ], "summary": "Get response tokens", "description": "Retrieve list of response tokens.", "operationId": "getResponseTokens", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ResponseTokenList" } } } } } }, "post": { "tags": [ "Response tokens" ], "summary": "Create response token", "description": "Create response token.", "operationId": "createResponseToken", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ResponseTokenDTO" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ResponseTokenDTO" } } } } } } }, "/{tenant}/target/properties": { "get": { "tags": [ "Properties" ], "summary": "List properties", "description": "Retrieve list of all properties.", "operationId": "getProperties", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/PropertyList" } } } } } }, "post": { "tags": [ "Properties" ], "summary": "Create a property", "description": "Create a property.", "operationId": "createProperty", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Property" } } } } } } }, "/{tenant}/target/offers/recs": { "post": { "tags": [ "Offers" ], "summary": "Create a new recs offer", "description": "Creates a new Recommendations offer as defined by the request data.", "operationId": "createOffer", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RecommendationOffer" } } } } } } }, "/{tenant}/target/offers/json": { "post": { "tags": [ "Offers" ], "summary": "Create a new json offer", "description": "Creates a new JSON offer as defined by the request data.", "operationId": "createOffer_1_1", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/JsonOffer" } } } } } } }, "/{tenant}/target/offers/content": { "post": { "tags": [ "Offers" ], "summary": "Create a new content offer", "description": "Creates a new content offer as defined by the request data.", "operationId": "createOffer_1_2", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ContentOffer" } } } } } } }, "/{tenant}/target/environments": { "get": { "tags": [ "Environments" ], "summary": "List environments", "description": "Retrieve all available environments with the options to filter and sort. Use the Environments API to retrieve the environment IDs corresponding to the various host groups set for the client.", "operationId": "getEnvironments", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/EnvironmentList" } } } } } }, "post": { "tags": [ "Environments" ], "summary": "Create environment", "description": "Create a new environment.", "operationId": "createEnvironment", "requestBody": { "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Environment" } } } } } } }, "/{tenant}/target/batch": { "post": { "tags": [ "Batch" ], "summary": "Execute Calls in Batch", "description": "Stack multiple REST API calls together and execute them in a single batch.", "operationId": "processBatchOperations", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "batchRequest": { "$ref": "#/components/schemas/BatchRequest" }, "authRequestData": { "$ref": "#/components/schemas/BatchAuthData" }, "requestHost": { "type": "string" } } } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BatchResponse" } } } } } } }, "/{tenant}/target/authentication/token": { "get": { "tags": [ "Authentication" ], "summary": "Get authorization token", "description": "Retrieve an existing authorization token to use for mbox trace or profile API access.", "operationId": "getAuthorizationToken", "parameters": [ { "name": "authorizationScope", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "profile_api", "debug_tools" ] } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AuthorizationToken" } } } } } }, "post": { "tags": [ "Authentication" ], "summary": "Create authorization token", "description": "Create a new authorization token for capturing mbox traces or profile API access.", "operationId": "requestAuthorizationToken", "requestBody": { "content": { "application/json": { "schema": { "type": "string", "enum": [ "profile_api", "debug_tools" ] } } } }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AuthorizationToken" } } } } } } }, "/{tenant}/target/audiences": { "get": { "tags": [ "Audiences" ], "summary": "List audiences", "description": "List all available audiences with options to filter and sort by each available field. You can use the URL parameters to define pagination properties and sort order of the list of audiences returned by this method.", "operationId": "getAudiences_1_1", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/AudienceList" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/AudienceList" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AudienceList" } } } } } }, "post": { "tags": [ "Audiences" ], "summary": "Create audience", "description": "Create a new audience as specified by the contents of the request and return the newly-created audience definition. Each audience definition is composed of either target or audience rules. Target rules allow the API caller to define conjunctions (OR) or disjunctions (AND) between various targeting conditions. Audience rules allow the API caller to build conjunctions (OR) or disjunctions (AND) over pre-built audiences (referred by IDs) to create even more powerful definitions. The targetRule and audienceRule attributes cannot be mixed within the same audience definition. Note: Audiences created using the API can only be edited using the API. You cannot edit an API-created audience in the UI, although you can use it within activities.", "operationId": "createAudience_1_1", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/Audience" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Audience" } } } } } } }, "/{tenant}/target/activities/abt": { "post": { "tags": [ "Activities" ], "summary": "Create AP activity", "description": "Create a new Automated Personalization activity based on the specified contents, and return the created activity.\u003cbr/\u003e\u003cb\u003eNote:\u003c/b\u003eCreating auto-target activities is currently not supported through the API.", "operationId": "createActivity_1", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABTActivity" } } } } } } }, "/{tenant}/target/activities/ab": { "post": { "tags": [ "Activities" ], "summary": "Create AB activity", "description": "Create a new AB activity based on the specified contents, and return the created activity.", "operationId": "createActivity_3_1", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } } }, "/{tenant}/target/activities/xt": { "post": { "tags": [ "Activities" ], "summary": "Create AB activity", "description": "Create a new AB activity based on the specified contents, and return the created activity.", "operationId": "createActivity_2_1_1", "parameters": [], "requestBody": { "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } }, "required": true }, "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "201": { "description": "Created", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ABActivity" } } } } } } }, "/{tenant}/target/revisions/{revisionResourceType}": { "get": { "tags": [ "Revisions" ], "summary": "Get the audit log by last author\u0027s name and a modified-after timestamp", "description": "Get all the revisions, filtered by author\u0027s name and modified-after timestamp (optional, in ISO-8601 format, default: last 1 day). \u003cbr/\u003eIn the response, the \u003ci\u003emodifiedBy\u003c/i\u003e field will contain the author\u0027s email, while the \u003ci\u003emodifiedByName\u003c/i\u003e will contain its name.", "operationId": "getRevisionLogForModifiedByName", "parameters": [ { "name": "revisionResourceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RevisionResourceType" } }, { "name": "modifiedBy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "modifiedAt", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RevisionLog" } } } } } } }, "/{tenant}/target/revisions/{revisionResourceType}/{id}": { "get": { "tags": [ "Revisions" ], "summary": "Get the audit log by entity id", "description": "Get all the revisions of an entity (activity / audience / offer / profile script / environment), in descending order by time. \u003cbr/\u003e\u003cb\u003ePlease Note:\u003c/b\u003e\u003cbr/\u003e Only the \u003cu\u003elatest 100 revisions\u003c/u\u003e will be retained per campaign/segment/offer id (including \u003ci\u003eCREATE\u003c/i\u003e and \u003ci\u003eDELETE\u003c/i\u003e actions, excluding \u003ci\u003ePATCH\u003c/i\u003e actions). \u003cbr/\u003e For property/environment, only concrete updates will be recorded.", "operationId": "getRevisionLog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionResourceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RevisionResourceType" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/RevisionLog" } } } } } } }, "/{tenant}/target/revisions/{revisionResourceType}/{id}/revision": { "get": { "tags": [ "Revisions" ], "summary": "Get a revision by timestamp", "description": "Get a specific revision created no later than a specified timestamp.", "operationId": "getRevisionBeforeTimestamp", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionResourceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RevisionResourceType" } }, { "name": "timestamp", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Revision" } } } } } } }, "/{tenant}/target/revisions/{revisionResourceType}/{id}/revision/{revisionId}": { "get": { "tags": [ "Revisions" ], "summary": "Get a revision by revision id", "description": "Get a specific revision by entity id and revision id.", "operationId": "getRevision", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "revisionResourceType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/RevisionResourceType" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Revision" } } } } } } }, "/{tenant}/target/profileattributes/mbox": { "get": { "tags": [ "Mboxes" ], "summary": "List profile attributes", "description": "Retrieve the list of available profile attributes and mbox parameters of type profile.", "operationId": "getMboxProfileAttributes", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/MboxProfileAttributesDTO" } } } } } } }, "/{tenant}/target/offers": { "get": { "tags": [ "Offers" ], "summary": "List offers", "description": "Retrieve the list of previously-created content/JSON/Recommendations offers. The parameters passed through the query string are optional and are used to indicate the sorting and filtering options.", "operationId": "getOffers_1", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/OfferList" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/OfferList" } } } } } } }, "/{tenant}/target/offers/templates": { "get": { "tags": [ "Offers" ], "summary": "List offer templates", "description": "Retrieve the list of previously-created offer templates.", "operationId": "getOfferTemplates", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/OfferTemplateList" } } } } } } }, "/{tenant}/target/offers/templates/{id}": { "get": { "tags": [ "Offers" ], "summary": "Get offer template by ID", "description": "Retrieves the contents of an offer template as referenced by its ID.", "operationId": "getOfferTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/OfferTemplate" } } } } } } }, "/{tenant}/target/mboxes": { "get": { "tags": [ "Mboxes" ], "summary": "List available mboxes", "description": "List all available mboxes for a specific client with the options to filter and sort.", "operationId": "getMboxes", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/MboxList" } } } } } } }, "/{tenant}/target/mbox/{mboxName}": { "get": { "tags": [ "Mboxes" ], "summary": "Get mbox parameters", "description": "Get the list of mbox parameters.", "operationId": "getMbox", "parameters": [ { "name": "mboxName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/Mbox" } } } } } } }, "/{tenant}/target/hosts": { "get": { "tags": [ "Hosts" ], "summary": "List hosts", "description": "Retrieve a list of all hosts.", "operationId": "getHosts", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/HostList" } } } } } } }, "/{tenant}/target/atjs/versions": { "get": { "tags": [ "Atjs" ], "summary": "Get at.js versions", "description": "Retrieve at.js versions.", "operationId": "getAtJsVersions", "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "type": "array", "items": { "type": "string" } } } } } } } }, "/{tenant}/target/activities": { "get": { "tags": [ "Activities" ], "summary": "List activities", "description": "Get a list of activities created in your Target account, with the ability to filter and sort by attributes.", "operationId": "getActivities_1_1", "parameters": [], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v3+json": { "schema": { "$ref": "#/components/schemas/ActivityList" } }, "application/vnd.adobe.target.v2+json": { "schema": { "$ref": "#/components/schemas/ActivityList" } }, "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityList" } } } } } } }, "/{tenant}/target/activities/{id}/changelog": { "get": { "tags": [ "Activities" ], "summary": "List activity changelog", "description": "Retrieve the changelog events related to the activity specified by ID", "operationId": "getChangelog", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityChangelogList" } } } } } } }, "/{tenant}/target/activities/abt/{id}/report/performance": { "get": { "tags": [ "Reports" ], "summary": "Get AP performance report", "description": "Retrieve performance report data for the Automated Personalization activity referenced by the provided ID.", "operationId": "getReportById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AbstractActivityPerformanceReport" } } } } } } }, "/{tenant}/target/activities/abt/{id}/report/orders": { "get": { "tags": [ "Reports" ], "summary": "Get AP orders report", "description": "Retrieve orders report data for the Automated Personalization activity referenced by the provided ID.", "operationId": "getReportById_1", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityOrdersReport" } } } } } } }, "/{tenant}/target/activities/ab/{id}/report/performance": { "get": { "tags": [ "Reports" ], "summary": "Get AB performance report", "description": "Retrieve performance report data for the AB activity referenced by the provided ID.", "operationId": "getReportById_2", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AbstractActivityPerformanceReport" } } } } } } }, "/{tenant}/target/activities/xt/{id}/report/performance": { "get": { "tags": [ "Reports" ], "summary": "Get AB performance report", "description": "Retrieve performance report data for the AB activity referenced by the provided ID.", "operationId": "getReportById_3", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/AbstractActivityPerformanceReport" } } } } } } }, "/{tenant}/target/activities/ab/{id}/report/orders": { "get": { "tags": [ "Reports" ], "summary": "Get AB orders report", "description": "Retrieve orders report data for the AB activity referenced by the provided ID.", "operationId": "getReportById_4", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityOrdersReport" } } } } } } }, "/{tenant}/target/activities/xt/{id}/report/orders": { "get": { "tags": [ "Reports" ], "summary": "Get AB orders report", "description": "Retrieve orders report data for the AB activity referenced by the provided ID.", "operationId": "getReportById_5", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ActivityOrdersReport" } } } } } } }, "/{tenant}/target/responsetokens/{id}": { "delete": { "tags": [ "Response tokens" ], "summary": "Delete response token", "description": "Delete response token referenced by the response token ID.", "operationId": "deleteResponseToken", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "400": { "description": "Bad Request", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "407": { "description": "Proxy Authentication Required", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "405": { "description": "Method Not Allowed", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "406": { "description": "Not Acceptable", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "415": { "description": "Unsupported Media Type", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "200": { "description": "OK", "content": { "application/vnd.adobe.target.v1+json": { "schema": { "$ref": "#/components/schemas/ResponseTokenDTO" } } } } } } } }, "components": { "schemas": { "workspace": { "maxLength": 250, "type": "string", "description": "In case of premium customers (customers with multiple workspaces), it\u0027s essential to add the workspace id in every request\u0027s payload. If one is not stated, the default workspace will be used. The API consumer must have \"approver\" privilege on the workspace used in the request, if not the API will respond with an error indicating the lack of sufficient privileges to perform the operation." }, "ActivityState": { "type": "string", "description": "\u003cp\u003eThere are four valid activity states: approved, saved, deactivated, and deleted.\u003c/p\u003e\u003cp\u003eThe \"Approved\" state has two attributes called startAt and endAt that play a vital role in what happens when you update the activity state to \"Approved\". startAt is the date and time that the activity is/was scheduled to begin. endAt is the date and time that the activity is/was scheduled to end.\u003c/p\u003e\u003cp\u003e\u003cb\u003eCaution\u003c/b\u003e: There is approximately a 15-minute latency between the API and the UI, so when setting dates give it time.\u0026nbsp;\u003c/p\u003e\u003cp\u003e\u0026nbsp;\u003c/p\u003e\u003cdiv\u003e\u003ctable\u003e\u003ctbody\u003e\u003ctr\u003e\u003cth\u003eAPI State\u003c/th\u003e\u003cth\u003eStart At\u003c/th\u003e\u003cth\u003eEnd At\u003c/th\u003e\u003cth\u003eUI Status\u003c/th\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eApproved\u003c/td\u003e\u003ctd\u003ein the past\u003c/td\u003e\u003ctd\u003ein the future\u003c/td\u003e\u003ctd\u003eLive\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eApproved\u003c/td\u003e\u003ctd\u003ein the past\u003c/td\u003e\u003ctd\u003ein the past\u003c/td\u003e\u003ctd\u003eEnded\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eApproved\u003c/td\u003e\u003ctd\u003ein the future\u003c/td\u003e\u003ctd\u003ein the future\u003c/td\u003e\u003ctd\u003eScheduled\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eSaved\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003eInactive\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eDeactivated\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003eArchived\u003c/td\u003e\u003c/tr\u003e\u003ctr\u003e\u003ctd\u003eDeleted\u0026nbsp;\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003e-\u003c/td\u003e\u003ctd\u003eDoes Not Appear in the UI\u003c/td\u003e\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\u003c/div\u003e\u003cp\u003e\u0026nbsp;\u003c/p\u003e\u003cp\u003e\u003cb\u003eNote\u003c/b\u003e: When setting an activity to any state using the API, the activity will stay the state that you set it to be even while the status in the UI changes. So if you set an activity to Approved and it passes the end date, the UI will show that it has ended, but the state will still be Approved.\u0026nbsp;\u003c/p\u003e\u003cp\u003e\u0026nbsp;\u003c/p\u003e\u003c/div\u003e ", "enum": [ "approved", "saved", "deactivated", "deleted" ] }, "RevisionResourceType": { "type": "string", "description": "\u003cp\u003especifies entity type to fetch revision or list of revisions\u003c/p\u003e\u003cp\u003eSupported entities:\u003c/p\u003e\u003cul\u003e\u003cli\u003eactivity\u003c/li\u003e\u003cli\u003eaudience\u003c/li\u003e\u003cli\u003eoffer\u003c/li\u003e\u003cli\u003eprofileScript\u003c/li\u003e\u003cli\u003eproperty\u003c/li\u003e\u003cli\u003eenvironment\u003c/li\u003e\u003c/ul\u003e", "enum": [ "activity", "audience", "offer", "profileScript", "property", "environment" ] }, "Error": { "type": "object", "properties": { "errorCode": { "type": "string" }, "message": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "object" } } } }, "ErrorResponse": { "type": "object", "properties": { "httpStatus": { "type": "integer", "format": "int32" }, "requestId": { "type": "string" }, "requestTime": { "type": "string", "format": "date-time" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } }, "Property": { "required": [ "channel", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "channel": { "type": "string", "enum": [ "web", "mobile", "email", "other" ] }, "createdAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "workspaces": { "maxItems": 200, "minItems": 0, "type": "array", "items": { "type": "string" } }, "token": { "type": "string" } } }, "PromotionSlotConfiguration": { "type": "object", "properties": { "maxSlots": { "type": "integer", "format": "int32" } } }, "Promotions": { "type": "object", "properties": { "front": { "type": "array", "items": { "$ref": "#/components/schemas/RecommendationUnitPromotionConfiguration" } }, "back": { "type": "array", "items": { "$ref": "#/components/schemas/RecommendationUnitPromotionConfiguration" } }, "internal": { "type": "array", "items": { "$ref": "#/components/schemas/RecommendationUnitPromotionConfiguration" } } } }, "RecommendationOffer": { "required": [ "criteriaId", "designId", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "designId": { "type": "integer", "format": "int64" }, "collectionId": { "type": "integer", "format": "int64" }, "criteriaId": { "type": "integer", "format": "int64" }, "promotions": { "$ref": "#/components/schemas/Promotions" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "RecommendationUnitPromotionConfiguration": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "configuration": { "$ref": "#/components/schemas/PromotionSlotConfiguration" } } }, "JsonNode": { "type": "object" }, "JsonOffer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "content": { "$ref": "#/components/schemas/JsonNode" }, "workspace": { "$ref": "#/components/schemas/workspace" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "ContentOffer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "content": { "type": "string" }, "workspace": { "$ref": "#/components/schemas/workspace" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "HostEnvironment": { "required": [ "environmentId" ], "type": "object", "properties": { "environmentId": { "type": "integer", "format": "int64" } } }, "Environment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "serveInactiveActivities": { "type": "boolean" }, "lastModified": { "type": "string", "format": "date-time" }, "default": { "type": "boolean" } } }, "DefaultEnvironmentsDTO": { "type": "object", "properties": { "reportingEnvironmentId": { "type": "integer", "format": "int64" }, "newHostEnvironmentId": { "type": "integer", "format": "int64" } } }, "UiSettingsDto": { "type": "object", "properties": { "defaultSimulatorUrl": { "type": "string" }, "enableExperienceThumbs": { "type": "boolean" }, "enableProxyInEe": { "type": "boolean" }, "loadMixedContent": { "type": "boolean" }, "useElementIds": { "type": "boolean" }, "useClassIds": { "type": "boolean" }, "enableFineGrainedPriorities": { "type": "boolean" }, "enableProjectedEarnings": { "type": "boolean" }, "reportingCloudSolution": { "type": "string", "enum": [ "target", "analytics", "cja", "transitional" ] } } }, "ClientSelfServiceSettings": { "type": "object", "properties": { "enableProfileApiAuthentication": { "type": "boolean" }, "locale": { "type": "string" }, "timeZone": { "type": "string" }, "ipObfuscation": { "type": "string", "enum": [ "NONE", "LAST_OCTET", "STRIP" ] }, "onDeviceDecisioning": { "type": "boolean" }, "onDeviceDecisioningActivityQualification": { "type": "boolean" }, "a4TEnabled": { "type": "boolean" }, "permissionEnabled": { "type": "boolean" }, "mobileDeviceTargetingEnabled": { "type": "boolean" }, "geoLocationEnabled": { "type": "boolean" }, "defaultCompanyName": { "type": "string" }, "defaultReportSuite": { "type": "string" }, "defaultDataCollectionHost": { "type": "string" } } }, "IpFilterDTO": { "type": "object", "properties": { "ip": { "type": "string" }, "netmask": { "type": "string" } } }, "IpFiltersDto": { "type": "object", "properties": { "ipFilters": { "type": "array", "items": { "$ref": "#/components/schemas/IpFilterDTO" } } } }, "AuthorizedMboxHosts": { "type": "object", "properties": { "enabledConstraints": { "type": "boolean" }, "authorizedMboxHostsConstraint": { "$ref": "#/components/schemas/MboxHostConstraints" }, "blockedMboxHostsConstraint": { "$ref": "#/components/schemas/MboxHostConstraints" } } }, "MboxHostConstraints": { "type": "object", "properties": { "contains": { "type": "array", "items": { "type": "string" } } } }, "Audience": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "description": { "type": "string" }, "origin": { "type": "string", "enum": [ "target", "cloud" ] }, "targetRule": { "$ref": "#/components/schemas/TargetRule" }, "audienceRule": { "$ref": "#/components/schemas/CompositeSegmentRule" }, "status": { "type": "string", "enum": [ "saved", "deleted" ] }, "type": { "type": "string", "enum": [ "reusable", "anonymous", "property" ] }, "modifiedAt": { "type": "string", "format": "date-time" }, "platform": { "$ref": "#/components/schemas/PlatformMetadata" }, "workspace": { "$ref": "#/components/schemas/workspace" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CompositeSegmentRule": { "type": "object", "properties": { "restRuleOperator": { "type": "string", "enum": [ "AND", "OR", "NOT" ] }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentRule" } } } }, "PlatformMetadata": { "type": "object", "properties": { "sandbox": { "$ref": "#/components/schemas/Sandbox" } } }, "Sandbox": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "SegmentRule": { "type": "object" }, "TargetRule": { "type": "object" }, "ATJSSettings": { "type": "object", "properties": { "clientCode": { "type": "string" }, "imsOrgId": { "type": "string" }, "decisioningMethod": { "type": "string" }, "artifactCacheTtl": { "type": "integer", "format": "int64" }, "profileLifetime": { "type": "integer", "format": "int64" }, "serverDomain": { "type": "string" }, "libraryHeader": { "type": "string" }, "libraryFooter": { "type": "string" }, "crossDomain": { "type": "string" }, "globalMboxName": { "type": "string" }, "globalMboxAutoCreate": { "type": "boolean" }, "legacyBrowserSupport": { "type": "boolean" }, "timeout": { "type": "integer", "format": "int64" } } }, "State": { "type": "object", "properties": { "state": { "$ref": "#/components/schemas/ActivityState" } } }, "ActivityDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "thirdPartyId": { "type": "string" }, "name": { "type": "string" }, "state": { "$ref": "#/components/schemas/ActivityState" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "priority": { "type": "integer", "format": "int32" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "Schedule": { "type": "object", "properties": { "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" } } }, "Priority": { "type": "object", "properties": { "priority": { "type": "integer", "format": "int32" } } }, "Name": { "type": "object", "properties": { "name": { "type": "string" } } }, "ABTActivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "thirdPartyId": { "type": "string" }, "name": { "type": "string" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "state": { "$ref": "#/components/schemas/ActivityState" }, "priority": { "type": "integer", "format": "int32" }, "entryConstraint": { "$ref": "#/components/schemas/EntryConstraint" }, "locations": { "$ref": "#/components/schemas/Locations" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Option" } }, "controlExperience": { "$ref": "#/components/schemas/ControlExperienceDTO" }, "targetedExperience": { "$ref": "#/components/schemas/TargetedExperiencesDTO" }, "optionGroups": { "type": "array", "items": { "$ref": "#/components/schemas/OptionGroup" } }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/Metric" } }, "reportingAudiences": { "type": "array", "items": { "$ref": "#/components/schemas/ReportingAudience" } }, "propertyIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "workspace": { "$ref": "#/components/schemas/workspace" }, "modifiedAt": { "type": "string", "format": "date-time" }, "analytics": { "$ref": "#/components/schemas/Analytics" } } }, "Analytics": { "type": "object", "properties": { "dataCollectionHost": { "type": "string" }, "reportSuites": { "type": "array", "items": { "$ref": "#/components/schemas/ReportSuites" } } } }, "AutomatedExperiencesDTO": { "type": "object", "properties": { "locationOptions": { "type": "array", "items": { "$ref": "#/components/schemas/LocationSegmentOptionsDTO" } }, "excludeRepeatingOptions": { "type": "boolean" }, "manualExclusions": { "type": "array", "items": { "$ref": "#/components/schemas/LocationOptionExperienceDTO" } } } }, "ClickTrackSelector": { "type": "object", "properties": { "selector": { "type": "string" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "selectorVersion": { "type": "integer", "format": "int32" } } }, "ControlExperienceDTO": { "type": "object", "properties": { "visitorPercentage": { "type": "integer", "format": "int32" }, "type": { "type": "string", "enum": [ "random", "default_content", "custom" ] }, "custom": { "$ref": "#/components/schemas/ExperienceDTO" } } }, "EntryConstraint": { "type": "object", "properties": { "mboxes": { "type": "array", "items": { "$ref": "#/components/schemas/EntryConstraintMbox" } }, "visitorPercentage": { "type": "integer", "format": "int32" } } }, "EntryConstraintMbox": { "type": "object", "properties": { "name": { "type": "string" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "ExperienceDTO": { "type": "object", "properties": { "experienceLocalId": { "type": "integer", "format": "int32" }, "locationOptions": { "type": "array", "items": { "$ref": "#/components/schemas/LocationOptionDTO" } } } }, "ExplicitExperiencesDTO": { "type": "object", "properties": { "optimizeByExperience": { "type": "boolean" }, "explicitExperiences": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentExperienceDTO" } } } }, "LocationOptionDTO": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, "optionLocalId": { "type": "integer", "format": "int32" } } }, "LocationOptionExperienceDTO": { "type": "object", "properties": { "locationOptions": { "type": "array", "items": { "$ref": "#/components/schemas/LocationOptionDTO" } } } }, "LocationSegmentOptionsDTO": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentOptionDTO" } } } }, "Locations": { "type": "object", "properties": { "mboxes": { "type": "array", "items": { "$ref": "#/components/schemas/Mbox" } }, "selectors": { "type": "array", "items": { "$ref": "#/components/schemas/Selector" } } } }, "Mbox": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "Metric": { "type": "object", "properties": { "metricLocalId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "conversion": { "type": "boolean" }, "engagement": { "type": "string", "enum": [ "page_count", "score", "time_on_site", "none" ] }, "optimizationCriteria": { "type": "string", "enum": [ "conversion_rate", "rpv", "aov", "none" ] }, "mboxes": { "type": "array", "items": { "$ref": "#/components/schemas/MetricMbox" } }, "clickTrackSelectors": { "type": "array", "items": { "$ref": "#/components/schemas/ClickTrackSelector" } }, "analytics": { "$ref": "#/components/schemas/Analytics" } } }, "MetricMbox": { "type": "object", "properties": { "name": { "type": "string" }, "successEvent": { "type": "string", "enum": [ "mbox_clicked", "mbox_shown" ] }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "OfferTemplate": { "type": "object", "properties": { "offerTemplateId": { "type": "integer", "format": "int64" }, "templateParameters": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateParameter" } } } }, "Option": { "type": "object", "properties": { "optionLocalId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "offerId": { "type": "integer", "format": "int64" }, "offerTemplates": { "type": "array", "items": { "$ref": "#/components/schemas/OfferTemplate" } } } }, "OptionGroup": { "type": "object", "properties": { "name": { "type": "string" }, "optionGroupLocalId": { "type": "integer", "format": "int32" }, "optionLocalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "ReportSuites": { "type": "object", "properties": { "companyName": { "type": "string" }, "reportSuites": { "type": "array", "items": { "type": "string" } } } }, "ReportingAudience": { "type": "object", "properties": { "reportingAudienceLocalId": { "type": "integer", "format": "int32" }, "audienceId": { "type": "integer", "format": "int64" }, "metricLocalId": { "type": "integer", "format": "int32" } } }, "SegmentExperienceDTO": { "type": "object", "properties": { "experienceLocalId": { "type": "integer", "format": "int32" }, "locationOptions": { "type": "array", "items": { "$ref": "#/components/schemas/LocationOptionDTO" } }, "segmentIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "SegmentOptionDTO": { "type": "object", "properties": { "optionLocalId": { "type": "integer", "format": "int32" }, "segmentIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "Selector": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "selector": { "type": "string" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "TargetedExperiencesDTO": { "type": "object", "properties": { "automatic": { "$ref": "#/components/schemas/AutomatedExperiencesDTO" }, "explicit": { "$ref": "#/components/schemas/ExplicitExperiencesDTO" }, "modelProvider": { "type": "string", "enum": [ "target", "custom_dsw" ] } } }, "TemplateParameter": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "ABActivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "thirdPartyId": { "type": "string" }, "name": { "type": "string" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "state": { "$ref": "#/components/schemas/ActivityState" }, "priority": { "type": "integer", "format": "int32" }, "entryConstraint": { "$ref": "#/components/schemas/EntryConstraint" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/Option" } }, "locations": { "$ref": "#/components/schemas/Locations" }, "experiences": { "type": "array", "items": { "$ref": "#/components/schemas/Experience" } }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/Metric" } }, "reportingAudiences": { "type": "array", "items": { "$ref": "#/components/schemas/ReportingAudience" } }, "analytics": { "$ref": "#/components/schemas/Analytics" }, "propertyIds": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int64" } }, "workspace": { "$ref": "#/components/schemas/workspace" }, "modifiedAt": { "type": "string", "format": "date-time" }, "views": { "type": "array", "items": { "$ref": "#/components/schemas/ViewReference" } }, "applicationContext": { "$ref": "#/components/schemas/ApplicationContext" } } }, "ApplicationContext": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "web", "mobile" ] }, "applicationVersions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "mobilePlatformVersions": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "deviceType": { "type": "string", "enum": [ "phone", "tablet" ] }, "screenOrientation": { "type": "string", "enum": [ "vertical", "horizontal" ] } } }, "Experience": { "type": "object", "properties": { "experienceLocalId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "visitorPercentage": { "type": "integer", "format": "int32" }, "optionLocations": { "type": "array", "items": { "$ref": "#/components/schemas/OptionLocation" } } } }, "OptionLocation": { "type": "object", "properties": { "locationLocalId": { "type": "integer", "format": "int32" }, "optionLocalId": { "type": "integer", "format": "int32" } } }, "ViewReference": { "type": "object", "properties": { "viewLocalId": { "type": "integer", "format": "int32" }, "viewId": { "type": "integer", "format": "int64" }, "audienceIds": { "type": "array", "items": { "type": "integer", "format": "int64" } } } }, "ResponseTokenDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "token": { "type": "string" }, "type": { "type": "string", "enum": [ "BUILT_IN", "ACTIVITY", "GEO", "CRS", "MBOX", "SCRIPT" ] } } }, "BatchOperation": { "required": [ "dependsOnOperationIds", "headers", "method", "relativeUrl" ], "type": "object", "properties": { "operationId": { "type": "integer", "format": "int32" }, "dependsOnOperationIds": { "maxItems": 255, "minItems": 0, "type": "array", "items": { "type": "integer", "format": "int32" } }, "method": { "type": "string", "enum": [ "GET", "POST", "PUT", "PATCH", "DELETE" ] }, "relativeUrl": { "type": "string" }, "headers": { "maxItems": 50, "minItems": 0, "type": "array", "items": { "$ref": "#/components/schemas/Header" } }, "body": { "$ref": "#/components/schemas/JsonNode" } } }, "BatchRequest": { "required": [ "operations" ], "type": "object", "properties": { "operations": { "maxItems": 256, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BatchOperation" } } } }, "Header": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "BatchAuthData": { "type": "object" }, "BatchOperationResponse": { "type": "object", "properties": { "operationId": { "type": "integer", "format": "int32" }, "skipped": { "type": "boolean" }, "statusCode": { "type": "integer", "format": "int32" }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/Header" } }, "body": { "type": "string" } } }, "BatchResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/BatchOperationResponse" } } } }, "AuthorizationToken": { "type": "object", "properties": { "accessToken": { "type": "string" }, "tokenType": { "type": "string" }, "scope": { "type": "string", "enum": [ "profile_api", "debug_tools" ] }, "expiresIn": { "type": "integer", "format": "int64" } } }, "AudiencePatch": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "workspace": { "$ref": "#/components/schemas/workspace" } } }, "Pagination": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" } } }, "RevisionLog": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "pagination": { "$ref": "#/components/schemas/Pagination" }, "revisions": { "type": "array", "items": { "$ref": "#/components/schemas/RevisionSummary" } } } }, "RevisionSummary": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "operation": { "type": "string", "enum": [ "create", "update", "patch", "delete", "auditError" ] }, "modifiedBy": { "type": "string" }, "modifiedByName": { "type": "string" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "Revision": { "type": "object", "properties": { "summary": { "$ref": "#/components/schemas/RevisionSummary" }, "jsonData": { "type": "string" } } }, "ResponseToken": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "token": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "BUILT_IN", "ACTIVITY", "GEO", "CRS", "MBOX", "SCRIPT" ] }, "modifiedAt": { "type": "string", "format": "date-time" }, "active": { "type": "boolean" }, "deletable": { "type": "boolean" } } }, "ResponseTokenList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "responseTokens": { "type": "array", "items": { "$ref": "#/components/schemas/ResponseToken" } } } }, "PropertyList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" } } } }, "MboxProfileAttributesDTO": { "type": "object", "properties": { "mboxProfileAttributes": { "type": "array", "items": { "type": "string" } } } }, "OfferList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "offers": { "type": "array", "items": { "$ref": "#/components/schemas/OfferListDescription" } } } }, "OfferListDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "type": { "type": "string", "enum": [ "content", "json", "recs" ] }, "modifiedAt": { "type": "string", "format": "date-time" }, "workspace": { "type": "string" } } }, "OfferTemplateList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "templates": { "type": "array", "items": { "$ref": "#/components/schemas/OfferTemplate" } } } }, "MboxList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "mboxes": { "type": "array", "items": { "$ref": "#/components/schemas/MboxListDescription" } } } }, "MboxListDescription": { "type": "object", "properties": { "name": { "type": "string" }, "status": { "type": "string" }, "lastRequestedAt": { "type": "string", "format": "date-time" } } }, "Host": { "type": "object", "properties": { "name": { "type": "string" }, "lastRequested": { "type": "string", "format": "date-time" }, "environmentId": { "type": "integer", "format": "int64" } } }, "HostList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "hosts": { "type": "array", "items": { "$ref": "#/components/schemas/Host" } } } }, "EnvironmentList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "environments": { "type": "array", "items": { "$ref": "#/components/schemas/Environment" } } } }, "AudienceList": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "audiences": { "type": "array", "items": { "$ref": "#/components/schemas/Audience" } } } }, "ActivityList": { "type": "object", "properties": { "total": { "type": "integer", "format": "int32" }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityListDescription" } } } }, "ActivityListDescription": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "thirdPartyId": { "type": "string" }, "type": { "type": "string", "enum": [ "ab", "xt", "abt", "auto_allocate", "mvt", "recs" ] }, "state": { "$ref": "#/components/schemas/ActivityState" }, "name": { "type": "string" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "lifetime": { "$ref": "#/components/schemas/CampaignLifetimeDTO" }, "priority": { "type": "integer", "format": "int32" }, "propertyIds": { "type": "array", "items": { "type": "integer", "format": "int64" } }, "workspace": { "type": "string" }, "modifiedAt": { "type": "string", "format": "date-time" } } }, "CampaignLifetimeDTO": { "type": "object", "properties": { "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" } } }, "ActivityChangelog": { "type": "object", "properties": { "modifiedAt": { "type": "string", "format": "date-time" }, "reportDataReset": { "type": "boolean" }, "activityParameters": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ActivityParameterChange" } }, "activityLocationOfferChange": { "$ref": "#/components/schemas/ActivityLocationOfferChange" }, "modifiedOffer": { "$ref": "#/components/schemas/IdAndName" }, "modifiedProfileAttribute": { "$ref": "#/components/schemas/IdAndName" }, "startedProfileAttribute": { "$ref": "#/components/schemas/IdAndName" }, "stoppedProfileAttribute": { "$ref": "#/components/schemas/IdAndName" } } }, "ActivityChangelogList": { "type": "object", "properties": { "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" }, "activityChangelogs": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityChangelog" } } } }, "ActivityLocationOfferChange": { "type": "object", "properties": { "changedValue": { "$ref": "#/components/schemas/IdAndName" }, "previousValue": { "$ref": "#/components/schemas/IdAndName" }, "mbox": { "$ref": "#/components/schemas/Mbox" }, "experience": { "$ref": "#/components/schemas/Experience" } } }, "ActivityParameterChange": { "type": "object", "properties": { "parameter": { "type": "string" }, "previousValue": { "type": "string" }, "changedValue": { "type": "string" } } }, "IdAndName": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } } }, "AbstractActivity": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "thirdPartyId": { "type": "string" }, "type": { "type": "string", "enum": [ "ab", "xt", "abt" ] }, "state": { "$ref": "#/components/schemas/ActivityState" }, "name": { "type": "string" }, "startsAt": { "type": "string", "format": "date-time" }, "endsAt": { "type": "string", "format": "date-time" }, "priority": { "type": "integer", "format": "int32" }, "modifiedAt": { "type": "string", "format": "date-time" }, "metrics": { "type": "array", "items": { "$ref": "#/components/schemas/MetricDTO" } }, "reportingAudiences": { "type": "array", "items": { "$ref": "#/components/schemas/ReportingAudience" } } } }, "AbstractActivityPerformanceReport": { "type": "object", "properties": { "reportParameters": { "$ref": "#/components/schemas/ActivityPerformanceReportParameters" }, "activity": { "$ref": "#/components/schemas/AbstractActivity" } } }, "ActivityPerformanceReportParameters": { "type": "object", "properties": { "activityId": { "type": "integer", "format": "int64" }, "environmentId": { "type": "integer", "format": "int64" }, "conversionMetricLocalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "metricLocalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "reportingAudienceLocalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "reportInterval": { "$ref": "#/components/schemas/Interval" }, "daysOfWeek": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "resolution": { "type": "string", "enum": [ "hour", "day", "week", "month" ] } } }, "Chronology": { "type": "object", "properties": { "zone": { "$ref": "#/components/schemas/DateTimeZone" } } }, "DateTimeZone": { "type": "object", "properties": { "id": { "type": "string" }, "fixed": { "type": "boolean" } } }, "Interval": { "type": "object", "properties": { "chronology": { "$ref": "#/components/schemas/Chronology" }, "start": { "type": "string", "format": "date-time" }, "end": { "type": "string", "format": "date-time" }, "startMillis": { "type": "integer", "format": "int64" }, "endMillis": { "type": "integer", "format": "int64" }, "afterNow": { "type": "boolean" }, "beforeNow": { "type": "boolean" } } }, "MetricDTO": { "type": "object", "properties": { "name": { "type": "string" }, "metricLocalId": { "type": "integer", "format": "int32" }, "deletedAt": { "type": "string", "format": "date-time" } } }, "ActivityOrdersReport": { "type": "object", "properties": { "reportParameters": { "$ref": "#/components/schemas/ActivityOrdersReportParameters" }, "activity": { "$ref": "#/components/schemas/AbstractActivity" }, "orders": { "type": "array", "items": { "$ref": "#/components/schemas/OrderDTO" } } } }, "ActivityOrdersReportParameters": { "type": "object", "properties": { "activityId": { "type": "integer", "format": "int64" }, "environmentId": { "type": "integer", "format": "int64" }, "reportInterval": { "$ref": "#/components/schemas/Interval" }, "conversionMetricLocalIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "OrderDTO": { "type": "object", "properties": { "experienceLocalId": { "type": "integer", "format": "int32" }, "decisionStackId": { "type": "integer", "format": "int32" }, "time": { "type": "string", "format": "date-time" }, "id": { "type": "string" }, "total": { "type": "number" }, "productIds": { "type": "array", "items": { "type": "string" } }, "outlier": { "type": "boolean" }, "duplicate": { "type": "boolean" } } } } } }