{ "openapi" : "3.0.1", "info" : { "title" : "adhook.io API", "contact" : { "name" : "Adhook GmbH", "email" : "hi@adhook.io" }, "version" : "1.0" }, "paths" : { "/v1/customEvents/{id}" : { "put" : { "tags" : [ "CustomEvent" ], "description" : "Updates a customEvent", "operationId" : "updateCustomEvent", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomEvent" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/customEvents" : { "post" : { "tags" : [ "CustomEvent" ], "description" : "Creates customEvent", "operationId" : "createCustomEvent", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomEvent" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/customEvents/externalId/{externalId}" : { "put" : { "tags" : [ "CustomEvent" ], "description" : "Creates or Updates a customEvent by externalId", "operationId" : "updateCustomEventByExternalId", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "externalId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomEvent" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/fcmDeviceToken" : { "post" : { "tags" : [ "FcmDeviceToken" ], "operationId" : "registerDeviceToken", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FcmDeviceTokenRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "FcmDeviceToken" ], "operationId" : "deleteDeviceToken_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FcmDeviceTokenRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/fcmDeviceToken/{deviceToken}" : { "delete" : { "tags" : [ "FcmDeviceToken" ], "operationId" : "deleteDeviceToken", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "deviceToken", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/notifications/count" : { "get" : { "tags" : [ "Notifications" ], "operationId" : "countNotifications", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/notifications/read" : { "put" : { "tags" : [ "Notifications" ], "operationId" : "readNotification", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/influencers/{id}/collaborations" : { "get" : { "tags" : [ "Influencer Collaborations" ], "description" : "Get all collaborations for an influencer", "operationId" : "getCollaborations", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "Influencer Collaborations" ], "description" : "Create a new collaboration for an influencer", "operationId" : "createCollaboration", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InfluencerCollaboration" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/influencers/{id}/collaborations/{collaborationId}" : { "put" : { "tags" : [ "Influencer Collaborations" ], "description" : "Update a collaboration", "operationId" : "updateCollaboration", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "collaborationId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InfluencerCollaboration" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Influencer Collaborations" ], "description" : "Delete a collaboration", "operationId" : "deleteCollaboration", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "collaborationId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/influencers/{id}" : { "get" : { "tags" : [ "Influencers" ], "description" : "Get influencer by ID", "operationId" : "getInfluencer", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "put" : { "tags" : [ "Influencers" ], "description" : "Update an influencer", "operationId" : "updateInfluencer", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Influencer" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Influencers" ], "description" : "Delete an influencer", "operationId" : "deleteInfluencer", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/influencers" : { "get" : { "tags" : [ "Influencers" ], "description" : "Get all influencers for the current tenant", "operationId" : "getAllInfluencers", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "status", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE", "ARCHIVED" ] } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "Influencers" ], "description" : "Create a new influencer", "operationId" : "createInfluencer", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Influencer" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/influencers/{id}/posts" : { "get" : { "tags" : [ "Influencers" ], "description" : "Get posts for an influencer with date range filtering", "operationId" : "getInfluencerPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "collaborationId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "Influencers" ], "description" : "Create a new post for an influencer", "operationId" : "createInfluencerPost", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InfluencerPost" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/influencers/{id}/posts/{postId}" : { "put" : { "tags" : [ "Influencers" ], "description" : "Update a post for an influencer", "operationId" : "updateInfluencerPost", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "postId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InfluencerPost" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Influencers" ], "description" : "Delete a post for an influencer", "operationId" : "deleteInfluencerPost", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "postId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/influencers/tab/{id}/overview" : { "get" : { "tags" : [ "Influencers" ], "description" : "Get influencer by ID", "operationId" : "getOverviewDetails", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/listings/{id}/status" : { "put" : { "tags" : [ "Listing" ], "operationId" : "updateStatus", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateLocationStatusRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/listings/{id}/images" : { "post" : { "tags" : [ "Listing" ], "operationId" : "uploadMedia", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/MediaItemBatchRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/listings" : { "get" : { "tags" : [ "Listing" ], "operationId" : "getListings", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/listings/count" : { "get" : { "tags" : [ "Listing" ], "operationId" : "countListings", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/listings/{id}/opening-hours" : { "put" : { "tags" : [ "Listing" ], "operationId" : "updateOpeningHours", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChangeHoursRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/listings/{id}/location-data" : { "put" : { "tags" : [ "Listing" ], "operationId" : "updateListingData", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LocationDataUpdateRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/listings/statistics" : { "get" : { "tags" : [ "Listing" ], "operationId" : "getListingStatistics", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/me/googleAdsAccount" : { "post" : { "tags" : [ "Google" ], "operationId" : "createGoogleAdsAccount", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateGoogleAdsAccountRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v2/socialMessageThreads/history" : { "get" : { "tags" : [ "Moderation" ], "description" : "Get activity log with pagination metadata", "operationId" : "getHistory", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "socialMessageThreadId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "socialMessageProfileId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "socialMessageId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/boardColumns/{id}" : { "put" : { "tags" : [ "Strategy" ], "description" : "Updates a boardColumn", "operationId" : "updateBoardColumn", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BoardColumn" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/boardColumns" : { "post" : { "tags" : [ "Strategy" ], "description" : "Creates boardColumn", "operationId" : "createBoardColumn", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BoardColumn" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/milestones/{id}" : { "put" : { "tags" : [ "Strategy" ], "description" : "Updates a milestone", "operationId" : "updateMilestone", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Milestone" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/milestones" : { "post" : { "tags" : [ "Strategy" ], "description" : "Creates milestone", "operationId" : "createMilestone", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Milestone" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tasks/{id}" : { "put" : { "tags" : [ "Strategy" ], "description" : "Updates a task", "operationId" : "updateTask", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Task" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tasks" : { "post" : { "tags" : [ "Strategy" ], "description" : "Creates task", "operationId" : "createTask", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Task" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v2/tasks/reorder" : { "put" : { "tags" : [ "Tasks" ], "description" : "Bulk update task order within a board column", "operationId" : "reorderTasks", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BulkReorderTasksRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/topics/{id}" : { "put" : { "tags" : [ "Strategy" ], "description" : "Updates a topic", "operationId" : "update", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/topics" : { "post" : { "tags" : [ "Strategy" ], "description" : "Creates topic", "operationId" : "create", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Topic" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "get", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "put" : { "tags" : [ "Promotion" ], "description" : "Updates a promotion", "operationId" : "updatePromotion", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Promotion" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Promotion" ], "operationId" : "deletePromotion", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "deleteInPlatform", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/v1/promotions/calendar" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "getCalendar", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "promotionStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "IN_PROGRESS", "STOPPED", "IN_REVIEW", "COMPLETED" ] } }, { "name" : "promotionType", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "SMART" ] } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "category", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionHeader" } } } } } } } }, "/v1/promotions/{id}/completeRegionReviewTask" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "completeRegionReviewTask", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CompleteManualProcessTaskRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/export/xlsx" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "getExcelExport", "parameters" : [ { "name" : "accessToken", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "promotionStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "IN_PROGRESS", "STOPPED", "IN_REVIEW", "COMPLETED" ] } }, { "name" : "promotionType", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "SMART" ] } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "dateFilterField", "in" : "query", "schema" : { "type" : "string", "enum" : [ "DEFAULT", "CREATED", "PUBLISHED" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : { "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "byte" } } } } } } } }, "/v1/promotions/{id}/assignee" : { "put" : { "tags" : [ "Promotion" ], "operationId" : "changeAssignee", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/UpdatePromotionAsssigneeRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/completeReviewTask" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "completeReviewTask", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CompleteManualProcessTaskRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "searchPromotions", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "promotionStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "IN_PROGRESS", "STOPPED", "IN_REVIEW", "COMPLETED" ] } }, { "name" : "promotionType", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "SMART" ] } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "dateFilterField", "in" : "query", "schema" : { "type" : "string", "enum" : [ "DEFAULT", "CREATED", "PUBLISHED" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionHeader" } } } } } } }, "post" : { "tags" : [ "Promotion" ], "description" : "Creates promotion", "operationId" : "createPromotion", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Promotion" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/count" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "countPromotions", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "promotionStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "IN_PROGRESS", "STOPPED", "IN_REVIEW", "COMPLETED" ] } }, { "name" : "promotionType", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "SMART" ] } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "dateFilterField", "in" : "query", "schema" : { "type" : "string", "enum" : [ "DEFAULT", "CREATED", "PUBLISHED" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CountResult" } } } } } } }, "/v1/promotions/{id}/automationSettings" : { "get" : { "tags" : [ "Promotion" ], "operationId" : "getAutomationSettings", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionAutomationSettings" } } } } } } }, "/v1/promotions/{id}/settings" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "updatePromotionSettings", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionSettingsRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/resubmit" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "resubmitPromotion", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CompleteManualProcessTaskRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/status" : { "put" : { "tags" : [ "Promotion" ], "operationId" : "updatePromotionStatus", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "type" : "string", "enum" : [ "CREATED", "READY", "PLANNED", "BLOCKED", "IN_PROGRESS", "COMPLETED", "DELETED", "STOPPED", "ERROR", "ACTIVATING", "IMPORTING", "READY_FOR_PAYMENT", "IN_REVIEW", "LOCKED", "PRODUCT_SYNCHRONIZING", "CHECK_REVIEW_FEEDBACK" ] } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/ads" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "appendAds", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AppendAdsRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/budgetSettings" : { "put" : { "tags" : [ "Promotion" ], "operationId" : "updatePromotionBudgetSettings", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdatePromotionBudgetAndBiddingRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/publishedPosts/importMedia" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "importPublishedPostMedia", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PostReadModel" } } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PostReadModel" } } } } } } } }, "/v1/promotions/{id}/activate" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "activateCampaign", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "If-Match", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ActivatePromotionRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/activate/retry" : { "post" : { "tags" : [ "Promotion" ], "operationId" : "retryActivation", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/facebook/image" : { "post" : { "tags" : [ "Facebook" ], "operationId" : "uploadImage", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadImageRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadImageResult" } } } } } } }, "/v1/promotions/facebook/video" : { "post" : { "tags" : [ "Facebook" ], "operationId" : "uploadVideo", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadVideoRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UploadVideoResult" } } } } } } }, "/v1/promotions/facebook/pages" : { "get" : { "tags" : [ "Facebook" ], "operationId" : "getPages", "parameters" : [ { "name" : "promotionId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "facebookAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/facebook/pages/list" : { "get" : { "tags" : [ "Facebook" ], "operationId" : "getPagesList", "parameters" : [ { "name" : "promotionId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "facebookAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/facebook/pages/search" : { "get" : { "tags" : [ "Facebook" ], "operationId" : "searchPages", "parameters" : [ { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/facebook/catalogs" : { "get" : { "tags" : [ "Facebook" ], "operationId" : "getCatalogs", "parameters" : [ { "name" : "facebookAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "instagramAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/facebook/products" : { "get" : { "tags" : [ "Facebook" ], "operationId" : "searchProducts", "parameters" : [ { "name" : "facebookAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "instagramAccountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "catalogId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/instagram/verifyAccount" : { "get" : { "tags" : [ "Instagram" ], "operationId" : "verifyAccountByUsername", "parameters" : [ { "name" : "username", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/linkedin/targeting/groups" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getGroups", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/titles" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getTitles", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/industries" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getIndustries", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/locations" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getLocations", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/reachestimation" : { "post" : { "tags" : [ "LinkedIn" ], "operationId" : "estimateReach", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReachEstimateRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ReachEstimateResult" } } } } } } }, "/v1/promotions/linkedin/targeting/degrees" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getDegrees", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/interests" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getInterests", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/memberBehaviors" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getMemberBehaviors", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/companyCategories" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getCompanyCategories", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/growthRates" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getGrowthRates", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/revenue" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getRevenue", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/schools" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getSchools", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/skills" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getSkills", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/employers" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getEmployers", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/jobFunctions" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getJobFunctions", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/targeting/seniorities" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getSeniorities", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "lang", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } } } } } }, "/v1/promotions/linkedin/suggestedBids" : { "post" : { "tags" : [ "LinkedIn" ], "operationId" : "getSuggestedLinkedInBids", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetSuggestedBidRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/linkedin/pages" : { "get" : { "tags" : [ "LinkedIn" ], "operationId" : "getLinkedInPages", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PageReadModel" } } } } } } } }, "/v1/promotions/linkedin/message-ads/test" : { "post" : { "tags" : [ "LinkedIn" ], "summary" : "Send a test message ad to the connected LinkedIn account", "operationId" : "sendTestMessage", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TestMessageAdRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/pinterest/locations" : { "get" : { "tags" : [ "Pinterest" ], "operationId" : "locations", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Location" } } } } } } } }, "/v1/promotions/pinterest/interests/browse" : { "get" : { "tags" : [ "Pinterest" ], "operationId" : "browseInterests", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "adAccountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InterestBrand" } } } } } } } }, "/v1/promotions/pinterest/ad-preview" : { "post" : { "tags" : [ "Pinterest" ], "operationId" : "createAdPreview", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdPreviewRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ThirdPartyPreviewResponse" } } } } } } }, "/v1/promotions/pinterest/ad-accounts" : { "get" : { "tags" : [ "Pinterest" ], "operationId" : "getPinterestAdAccounts", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinterestAdAccount" } } } } } } } }, "/v1/promotions/{id}/reactivation" : { "post" : { "tags" : [ "Promotion" ], "description" : "Reactivates promotion", "operationId" : "reactivatePromotion", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionReactivationRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/snapchat/profile" : { "get" : { "tags" : [ "Snapchat" ], "operationId" : "getProfile", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/snapchat/ad-accounts" : { "get" : { "tags" : [ "Snapchat" ], "operationId" : "getSnapchatAdAccounts", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accountId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SnapchatAdAccount" } } } } } } } }, "/v1/promotions/{id}/placementStatistic" : { "get" : { "tags" : [ "Statistic - Placement" ], "operationId" : "getPlacementStatistics", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sortBy", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortDirection", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fetchMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AGGREGATED", "DAILY" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PromotionStatisticResult" } } } } } } }, "/v1/promotions/{id}/placementStatistic/status" : { "put" : { "tags" : [ "Statistic - Placement" ], "operationId" : "updatePlacementStatus", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdatePlacementStatusRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/promotions/{id}/adStatistic/status" : { "put" : { "tags" : [ "Statistic - Ad" ], "operationId" : "updateAdStatus", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateAdStatusRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/adStatistic" : { "get" : { "tags" : [ "Statistic - Ad" ], "operationId" : "getAdStatistics", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sortBy", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortDirection", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fetchMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AGGREGATED", "DAILY" ] } }, { "name" : "statusFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdStatistic" } } } } } } }, "put" : { "tags" : [ "Statistic - Ad" ], "operationId" : "modifyAd", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ModifiedAdRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ModifiedAdRequest" } } } } } } }, "/v1/promotions/{id}/adStatistic/{adStatisticId}" : { "get" : { "tags" : [ "Statistic - Ad" ], "operationId" : "getAdStatistic", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adStatisticId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdStatistic" } } } } } } }, "/v1/promotions/{id}/adStatistic/{adStatisticId}/status" : { "put" : { "tags" : [ "Statistic - Ad" ], "operationId" : "updateAdStatisticStatus", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adStatisticId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdStatistic" } } } } } } }, "/v2/promotions/{id}/adStatistic" : { "get" : { "tags" : [ "Statistic - Ad" ], "operationId" : "getAdStatistics_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sortBy", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortDirection", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fetchMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AGGREGATED", "DAILY" ] } }, { "name" : "statusFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/promotions/{id}/channelStatistic" : { "get" : { "tags" : [ "Statistic - Channel" ], "operationId" : "getChannelStatistics", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "sortBy", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "sortDirection", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "fetchMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AGGREGATED", "DAILY" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ChannelStatisticResult" } } } } } } }, "/v1/promotions/{id}/targetStatistic" : { "get" : { "tags" : [ "Statistic - Target" ], "operationId" : "getTargetStatistics", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "fetchMode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "AGGREGATED", "DAILY" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetStatistic" } } } } } } } }, "/v1/posts/posting-time-insights" : { "get" : { "tags" : [ "Post" ], "operationId" : "getPostingTimeInsights", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "excludePostId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "publicationDate", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}" : { "get" : { "tags" : [ "Post" ], "operationId" : "get_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "put" : { "tags" : [ "Post" ], "description" : "Updates a post", "operationId" : "updatePost", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Post" ], "operationId" : "deletePost", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "deleteInPlatform", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "informCreatorAboutDeletion", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "reasonForDeletion", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { } } } } } }, "/v1/posts/{id}/resubmit" : { "post" : { "tags" : [ "Post" ], "operationId" : "resubmit", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CompleteManualProcessTaskRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/calendar" : { "get" : { "tags" : [ "Post" ], "operationId" : "getCalendar_1", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "postStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "PUBLISHED", "IN_REVIEW", "MANUALLY_ACTIVATING", "TRANSLATION_IN_PROGRESS", "TRANSLATION_COMPLETED", "NON_PUBLISHED" ] } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "category", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/publishManually" : { "get" : { "tags" : [ "Post" ], "operationId" : "getPostsToBePublishedManually", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts" : { "get" : { "tags" : [ "Post" ], "operationId" : "getPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "postStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "PUBLISHED", "IN_REVIEW", "MANUALLY_ACTIVATING", "TRANSLATION_IN_PROGRESS", "TRANSLATION_COMPLETED", "NON_PUBLISHED" ] } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } }, { "name" : "dateFilterField", "in" : "query", "schema" : { "type" : "string", "enum" : [ "DEFAULT", "CREATED", "PUBLISHED" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "Post" ], "description" : "Creates post", "operationId" : "createPost", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/export/xlsx" : { "get" : { "tags" : [ "Post" ], "operationId" : "getExcelExport_1", "parameters" : [ { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "accessToken", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "postStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "PUBLISHED", "IN_REVIEW", "MANUALLY_ACTIVATING", "TRANSLATION_IN_PROGRESS", "TRANSLATION_COMPLETED", "NON_PUBLISHED" ] } }, { "name" : "orderKey", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "reverseOrder", "in" : "query", "schema" : { "type" : "boolean" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : { } } } } } }, "/v1/posts/{id}/assignee" : { "put" : { "tags" : [ "Post" ], "operationId" : "changeAssignee_1", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/UpdateAssigneeRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/completeReviewTask" : { "post" : { "tags" : [ "Post" ], "operationId" : "completeReviewTask_1", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CompleteManualProcessTaskRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/recentlyCreated" : { "get" : { "tags" : [ "Post" ], "operationId" : "getRecentlyCreatedPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/recentlyUpdated" : { "get" : { "tags" : [ "Post" ], "operationId" : "getRecentlyUpdatedPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/recentlyCreatedOrUpdated" : { "get" : { "tags" : [ "Post" ], "operationId" : "getRecentlyCreatedOrUpdatedPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/count" : { "get" : { "tags" : [ "Post" ], "operationId" : "countPosts", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "tagIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup2", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "tagIdsGroup3", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "topicIds", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "postStatus", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DRAFT", "PLANNED", "PUBLISHED", "IN_REVIEW", "MANUALLY_ACTIVATING", "TRANSLATION_IN_PROGRESS", "TRANSLATION_COMPLETED", "NON_PUBLISHED" ] } }, { "name" : "start", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "end", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "category", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "dateFilterField", "in" : "query", "schema" : { "type" : "string", "enum" : [ "DEFAULT", "CREATED", "PUBLISHED" ] } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/grid" : { "get" : { "tags" : [ "Post" ], "operationId" : "getGridPreviewData", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "channels", "in" : "query", "schema" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/addToBio" : { "get" : { "tags" : [ "Post" ], "operationId" : "getPostsToBeAddedToBio", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "groupId", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/externalId/{externalId}" : { "put" : { "tags" : [ "Post" ], "description" : "Creates or Updates a post by externalId", "operationId" : "updatePostByExternalId", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "externalId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/backToDraft" : { "put" : { "tags" : [ "Post" ], "description" : "Updates a post status back to draft", "operationId" : "updatePostStatus", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/markAsPublished" : { "put" : { "tags" : [ "Post" ], "description" : "Updates a post status to published", "operationId" : "markAsPublished", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/startPromotion" : { "post" : { "tags" : [ "Post" ], "operationId" : "startPromotion", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Post" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/activate" : { "post" : { "tags" : [ "Post" ], "operationId" : "activatePost", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ActivatePostRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/activate/retry" : { "post" : { "tags" : [ "Post" ], "operationId" : "retryActivation_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/completeTranslationWorkflow" : { "put" : { "tags" : [ "Post" ], "operationId" : "completeTranslation", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/UpdateAssigneeRequest" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/cancelTranslationWorkflow" : { "put" : { "tags" : [ "Post" ], "operationId" : "cancelTranslation", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/posts/{id}/postStatistic" : { "get" : { "tags" : [ "Statistic - Post" ], "operationId" : "getPostStatistic", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/subtenants" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getSubtenants", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } } }, "put" : { "tags" : [ "Subtenants" ], "operationId" : "updateSubtenant", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubtenantUpdateModel" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } }, "post" : { "tags" : [ "Subtenants" ], "operationId" : "createSubtenant", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubtenantUpdateModel" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } } }, "/v1/subtenants/{subtenantId}" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getSubtenant", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "delete" : { "tags" : [ "Subtenants" ], "operationId" : "deleteSubtenant", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/subtenants/read" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getReadSubtenants", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } } } }, "/v1/subtenants/write" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getWriteSubtenants", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "mode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "CAMPAIGN", "POST", "CAMPAIGN_GENERATION", "POST_GENERATION", "POST_TEMPLATE", "AD_TEMPLATE", "MANAGE", "REVIEW", "MODERATION", "DEFAULT", "LISTINGS", "LISTENING", "MEDIA_LIBRARY" ] } }, { "name" : "statusFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE" ] } }, { "name" : "languageFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } } } }, "/v1/subtenants/write/count" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getWriteSubtenantsCount", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "mode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "CAMPAIGN", "POST", "CAMPAIGN_GENERATION", "POST_GENERATION", "POST_TEMPLATE", "AD_TEMPLATE", "MANAGE", "REVIEW", "MODERATION", "DEFAULT", "LISTINGS", "LISTENING", "MEDIA_LIBRARY" ] } }, { "name" : "statusFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE" ] } }, { "name" : "languageFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/subtenants/read/browse" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getBrowseableReadSubtenants", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "mode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "CAMPAIGN", "POST", "CAMPAIGN_GENERATION", "POST_GENERATION", "POST_TEMPLATE", "AD_TEMPLATE", "MANAGE", "REVIEW", "MODERATION", "DEFAULT", "LISTINGS", "LISTENING", "MEDIA_LIBRARY" ] } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/subtenants/write/browse" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getBrowseableWriteSubtenants", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "mode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "CAMPAIGN", "POST", "CAMPAIGN_GENERATION", "POST_GENERATION", "POST_TEMPLATE", "AD_TEMPLATE", "MANAGE", "REVIEW", "MODERATION", "DEFAULT", "LISTINGS", "LISTENING", "MEDIA_LIBRARY" ] } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SubtenantReadModel" } } } } } } } }, "/v1/subtenants/{subtenantId}/connectBiolinkPage" : { "put" : { "tags" : [ "Subtenants" ], "operationId" : "connectBiolinkPage", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/subtenants/{subtenantId}/deconnectBiolinkPage" : { "put" : { "tags" : [ "Subtenants" ], "operationId" : "deconnectBiolinkPage", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "subtenantId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v2/subtenants/write" : { "get" : { "tags" : [ "Subtenants" ], "operationId" : "getWriteSubtenants_1", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "mode", "in" : "query", "schema" : { "type" : "string", "enum" : [ "CAMPAIGN", "POST", "CAMPAIGN_GENERATION", "POST_GENERATION", "POST_TEMPLATE", "AD_TEMPLATE", "MANAGE", "REVIEW", "MODERATION", "DEFAULT", "LISTINGS", "LISTENING", "MEDIA_LIBRARY" ] } }, { "name" : "statusFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE" ] } }, { "name" : "languageFilter", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tags/{id}" : { "put" : { "tags" : [ "Tags" ], "description" : "Updates a tag", "operationId" : "updateTag", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/tags" : { "post" : { "tags" : [ "Tags" ], "description" : "Creates tag", "operationId" : "createTag", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Tag" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/teams/{id}" : { "put" : { "tags" : [ "Teams" ], "description" : "Updates a team", "operationId" : "updateTeam", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/teams" : { "post" : { "tags" : [ "Teams" ], "description" : "Creates team", "operationId" : "createTeam", "parameters" : [ { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Team" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/targetingTemplates/{targetingTemplateId}" : { "put" : { "tags" : [ "TargetingTemplates" ], "operationId" : "updateTargetingTemplate", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "targetingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TargetingTemplate" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/targetingTemplates" : { "get" : { "tags" : [ "TargetingTemplates" ], "operationId" : "getTargetingTemplates", "parameters" : [ { "name" : "subtenantId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "status", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE", "DRAFT" ] } }, { "name" : "adTemplateId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "postTemplateId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "adhookToken", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } }, "post" : { "tags" : [ "TargetingTemplates" ], "operationId" : "createTargetingTemplate", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TargetingTemplate" } } } }, "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/targetingTemplates/write" : { "get" : { "tags" : [ "TargetingTemplates" ], "operationId" : "getTargetingTemplatesToManage", "parameters" : [ { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "status", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE", "DRAFT" ] } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } }, "/v1/targetingTemplates/{targetingTemplateId}/promotion" : { "get" : { "tags" : [ "TargetingTemplates" ], "operationId" : "getTargetingTemplatePromotion", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "targetingTemplateId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Promotion" } } } } } } }, "/v1/targetingTemplates/{id}" : { "delete" : { "tags" : [ "TargetingTemplates" ], "operationId" : "deleteTargetingTemplate", "parameters" : [ { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/v2/targetingTemplates/write" : { "get" : { "tags" : [ "TargetingTemplates" ], "operationId" : "getTargetingTemplatesToManage_1", "parameters" : [ { "name" : "filter", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "q", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "skip", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "status", "in" : "query", "schema" : { "type" : "string", "enum" : [ "ALL", "ACTIVE", "INACTIVE", "DRAFT" ] } }, { "name" : "limit", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "userId", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "Authorization", "in" : "header", "schema" : { "type" : "string" } }, { "name" : "Origin", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "default" : { "description" : "default response", "content" : { "application/json" : { } } } } } } }, "components" : { "schemas" : { "PostTargeting" : { "type" : "object", "properties" : { "linkedInLanguageTargeting" : { "type" : "boolean" }, "selectedLinkedInLanguages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "linkedInRegionTargeting" : { "type" : "boolean" }, "selectedLinkedInRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "facebookRegionTargeting" : { "type" : "boolean" }, "selectedFacebookCountries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "facebookLocaleTargeting" : { "type" : "boolean" }, "selectedFacebookLocales" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } } } }, "StatisticPerPlacement" : { "type" : "object", "properties" : { "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "clicks" : { "type" : "integer", "format" : "int64" }, "cost" : { "type" : "number", "format" : "double" }, "device" : { "type" : "string", "enum" : [ "UNKNOWN", "DESKTOP", "HIGH_END_MOBILE", "TABLET", "MOBILE_WEB" ] }, "impressions" : { "type" : "integer", "format" : "int64" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "retweets" : { "type" : "integer", "format" : "int32" }, "likes" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" } } }, "DynamicSearchSettings" : { "type" : "object", "properties" : { "domainName" : { "type" : "string" }, "languageCode" : { "type" : "string" } } }, "PromotionGoogleUserList" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" }, "bidModifier" : { "type" : "number", "format" : "double" }, "bidModifierType" : { "type" : "string", "enum" : [ "INCREASE", "DECREASE" ] } } }, "UpdatePromotionAsssigneeRequest" : { "type" : "object", "properties" : { "assigneeUserId" : { "type" : "string" }, "hint" : { "type" : "string" }, "ccUserIds" : { "type" : "array", "items" : { "type" : "string" } } } }, "Document" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "fileType" : { "type" : "string" }, "title" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int32" }, "nbrOfPreviewPages" : { "type" : "integer", "format" : "int32" } } }, "GetSuggestedBidRequest" : { "type" : "object", "properties" : { "promotionId" : { "type" : "string" }, "target" : { "$ref" : "#/components/schemas/Target" }, "targetingTemplateId" : { "type" : "string" }, "budgetChannel" : { "$ref" : "#/components/schemas/BudgetChannel" }, "lifetimeBudget" : { "type" : "number", "format" : "double" }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "currency" : { "type" : "string" }, "costType" : { "type" : "string", "enum" : [ "CPC", "CPM", "CPS" ] } } }, "FrequencyControlLinkedInSpec" : { "type" : "object", "properties" : { "durationInDays" : { "type" : "integer", "format" : "int32" }, "frequency" : { "type" : "integer", "format" : "int32" } } }, "Mention" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "PERSON", "ORGANIZATION" ] }, "externalId" : { "type" : "string" }, "name" : { "type" : "string" } } }, "LocationAddress" : { "type" : "object", "properties" : { "postalCode" : { "type" : "string" }, "street" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "city" : { "type" : "string" } } }, "MonitoredHashtag" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "instagramId" : { "type" : "string" } } }, "InfluencerGoal" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "kpi" : { "type" : "string", "enum" : [ "NUMBER_OF_POSTS", "IMPRESSIONS", "LIKES", "COMMENTS", "ENGAGEMENTS" ] }, "goalValue" : { "type" : "string" }, "startDate" : { "type" : "string" }, "endDate" : { "type" : "string" } } }, "LocationDataUpdateRequest" : { "type" : "object", "properties" : { "locationName" : { "type" : "string" }, "primaryPhone" : { "type" : "string" }, "primaryAddress" : { "$ref" : "#/components/schemas/LocationAddress" }, "primaryEmail" : { "type" : "string" }, "website" : { "type" : "string" } } }, "ProfileMonitoring" : { "type" : "object", "properties" : { "profiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoredProfile" } } } }, "UploadImageRequest" : { "type" : "object", "properties" : { "promotionId" : { "type" : "string" }, "imageUrl" : { "type" : "string" }, "accountId" : { "type" : "string" }, "subtenantId" : { "type" : "string" } } }, "Retargeting" : { "type" : "object", "properties" : { "googleUserLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionGoogleUserList" } }, "facebookCustomAudiences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionFacebookCustomAudience" } }, "linkedInMatchedAudiences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionLinkedInMatchedAudience" } }, "twitterCustomAudiences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionTwitterMatchedAudience" } }, "tikTokAudiences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionTikTokAudience" } }, "pinterestAudiences" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionPinterestAudience" } } } }, "StatisticNotification" : { "type" : "object", "properties" : { "showCampaignInsights" : { "type" : "boolean" }, "showPostInsights" : { "type" : "boolean" }, "showOrganicPostInsights" : { "type" : "boolean" }, "showPaidPostInsights" : { "type" : "boolean" }, "showFollowerInsights" : { "type" : "boolean" }, "showListingInsights" : { "type" : "boolean" }, "showListingRanking" : { "type" : "boolean" }, "listingRankingReportId" : { "type" : "string" }, "email" : { "type" : "string" }, "ccEmailAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "firstname" : { "type" : "string" }, "name" : { "type" : "string" }, "notificationsMode" : { "type" : "string", "enum" : [ "DAILY", "THREE_DAYS", "WEEKLY", "MONTHLY", "NONE" ] }, "sentNotificationsTimestampProtocol" : { "type" : "array", "items" : { "type" : "string" } }, "language" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] }, "includeCost" : { "type" : "boolean" } } }, "PreviewContextInformation" : { "type" : "object", "properties" : { "draftTweetIds" : { "type" : "array", "items" : { "type" : "string" } } } }, "BoardColumn" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "order" : { "type" : "integer", "format" : "int32" }, "color" : { "type" : "string" }, "taskStatus" : { "type" : "string", "enum" : [ "TODO", "IN_PROGRESS", "IN_REVIEW", "DONE" ] } } }, "CountResult" : { "type" : "object", "properties" : { "count" : { "type" : "integer", "format" : "int64" } } }, "ShoppingSettings" : { "type" : "object", "properties" : { "googleMerchantAccount" : { "$ref" : "#/components/schemas/GoogleMerchantAccount" }, "salesCountry" : { "type" : "string" }, "enableLocal" : { "type" : "boolean" }, "googleShoppingCampaignType" : { "type" : "string", "enum" : [ "CLASSIC", "SMART" ] }, "productScopeType" : { "type" : "string", "enum" : [ "NONE", "FILTER" ] }, "productScopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProductScope" } }, "facebookProductCatalog" : { "$ref" : "#/components/schemas/FacebookProductCatalog" }, "facebookDynamicAdsTargetingType" : { "type" : "string", "enum" : [ "RETARGETING", "BROAD" ] }, "facebookProductSet" : { "$ref" : "#/components/schemas/FacebookProductSet" }, "facebookRetargetingIncludedRetentionDays" : { "type" : "integer", "format" : "int32" }, "facebookRetargetingExcludedRetentionDays" : { "type" : "integer", "format" : "int32" } } }, "LinkedInTargetingCriteriaGroup" : { "type" : "object", "properties" : { "linkedInTargetingEntityLinkOperator" : { "type" : "string", "enum" : [ "AND", "OR" ] }, "linkedInTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } } } }, "MonitoredNews" : { "type" : "object", "properties" : { "keywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NewsKeyword" } }, "countries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NewsCountry" } }, "languages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NewsLanguage" } } } }, "KeywordAutomationSettings" : { "type" : "object", "properties" : { "keyword" : { "$ref" : "#/components/schemas/GoogleKeyword" }, "adWordsAdGroupId" : { "type" : "string" } } }, "MonitoredProfile" : { "type" : "object", "properties" : { "username" : { "type" : "string" }, "id" : { "type" : "string" }, "followers_count" : { "type" : "integer", "format" : "int32" }, "follows_count" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "profilePictureUrl" : { "type" : "string" } } }, "TargetingTemplate" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE", "DRAFT", "DELETED" ] }, "name" : { "type" : "string" }, "userId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "promotionId" : { "type" : "string" }, "targetRegionMode" : { "type" : "string", "enum" : [ "SUBTENANT_REGIONS", "DEFINE_REGIONS" ] }, "useIncludedSubtenantCustomAudiencesGroup1" : { "type" : "boolean" }, "useIncludedSubtenantCustomAudiencesGroup2" : { "type" : "boolean" }, "useExcludedSubtenantCustomAudiences" : { "type" : "boolean" }, "target" : { "$ref" : "#/components/schemas/Target" }, "subtenantId" : { "type" : "string" }, "visibility" : { "type" : "string", "enum" : [ "ME", "ALL", "SELECTED_SUBTENANTS" ] }, "selectedSubtenants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "languageVisibility" : { "type" : "string", "enum" : [ "ALL", "SELECTED_LANGUAGES" ] }, "selectedLanguages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "timeRangeVisibility" : { "type" : "string", "enum" : [ "ALWAYS", "CUSTOM" ] }, "validFrom" : { "type" : "string" }, "validTo" : { "type" : "string" } } }, "GeneratedLinkPreview" : { "type" : "object", "properties" : { "link" : { "type" : "string" }, "title" : { "type" : "string" }, "description" : { "type" : "string" }, "imageUrl" : { "type" : "string" } } }, "BrevoUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "key" : { "type" : "string" } } }, "NewsKeyword" : { "type" : "object", "properties" : { "keyword" : { "type" : "string" } } }, "TaskOrderUpdate" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "order" : { "type" : "integer", "format" : "int32" }, "boardColumnId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "TODO", "IN_PROGRESS", "IN_REVIEW", "DONE" ] } } }, "Link" : { "type" : "object", "properties" : { "url" : { "type" : "string" } } }, "AdVariation" : { "type" : "object", "properties" : { "adId" : { "type" : "string" }, "feedItemId" : { "type" : "string" }, "businessName" : { "type" : "string" }, "longTitle" : { "type" : "string" }, "searchAdType" : { "type" : "string", "enum" : [ "EXPANDED", "RESPONSIVE" ] }, "textType" : { "type" : "string", "enum" : [ "SHORT", "LONG" ] }, "textAdType" : { "type" : "string", "enum" : [ "TEXT_AD", "DYNAMIC_TEXT_AD", "CLICK_TO_CALL_AD", "SHOPPING_AD", "SHOPPING_SHOWCASE_AD" ] }, "slides" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CarouselSlideVariation" } }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "twitterUser" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "titles" : { "type" : "array", "items" : { "type" : "string" } }, "pinnedTitles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinnedTextAsset" } }, "title" : { "type" : "string" }, "title2" : { "type" : "string" }, "title3" : { "type" : "string" }, "descriptions" : { "type" : "array", "items" : { "type" : "string" } }, "pinnedDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinnedTextAsset" } }, "description" : { "type" : "string" }, "description2" : { "type" : "string" }, "dynamicAdDescription1" : { "type" : "string" }, "dynamicAdDescription2" : { "type" : "string" }, "image" : { "$ref" : "#/components/schemas/Image" }, "squareImage" : { "$ref" : "#/components/schemas/Image" }, "verticalImage" : { "$ref" : "#/components/schemas/Image" }, "video" : { "$ref" : "#/components/schemas/Video" }, "verticalVideo" : { "$ref" : "#/components/schemas/Video" }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "squareImages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "logos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "squareLogos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "videos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "youTubeVideos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/YouTubeVideo" } }, "link" : { "type" : "string" }, "displayLink" : { "type" : "string" }, "linkDescription" : { "type" : "string" }, "utmLink" : { "type" : "string" }, "channelReferenceLink" : { "type" : "string" }, "callToAction" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] }, "displayLinkPath" : { "$ref" : "#/components/schemas/DisplayLinkPath" }, "phoneNumber" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "callOnlyDescription1" : { "type" : "string" }, "callOnlyDescription2" : { "type" : "string" }, "facebookPostId" : { "type" : "string" }, "instagramPostId" : { "type" : "string" }, "twitterTweetId" : { "type" : "string" }, "linkedInPostId" : { "type" : "string" }, "tikTokPostId" : { "type" : "string" }, "pinterestPinId" : { "type" : "string" }, "youTubePostId" : { "type" : "string" }, "carouselMultiShareEndCard" : { "type" : "boolean" }, "carouselMultiShareOptimized" : { "type" : "boolean" }, "facebookInstantExperienceId" : { "type" : "string" }, "facebookInstantExperienceThumbnails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInstantExperienceThumbnail" } }, "tikTokProfileName" : { "type" : "string" }, "tikTokProfileImage" : { "$ref" : "#/components/schemas/Image" }, "document" : { "$ref" : "#/components/schemas/Document" }, "showMemberProfilePhoto" : { "type" : "boolean" }, "senderUrn" : { "type" : "string" }, "ctaLabel" : { "type" : "string" }, "eventUrl" : { "type" : "string" }, "adType" : { "type" : "string", "enum" : [ "TEXT", "IMAGE", "VIDEO", "SPOTLIGHT", "SHOPPING", "COLLECTION", "CAROUSEL", "DOCUMENT", "MESSAGE", "EVENT" ] }, "pinterestBoard" : { "$ref" : "#/components/schemas/Board" }, "adStatus" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "id" : { "type" : "string" }, "type" : { "type" : "string", "writeOnly" : true, "enum" : [ "SHORT", "LONG" ] } } }, "Group" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "externalProcessGroupId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantIds" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "permissions" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "READ_PROMOTION", "WRITE_PROMOTION", "MANAGE_PROMOTION_TARGETS", "MANAGE_PROMOTION_UTM_TAGS", "MANAGE_PROMOTION_BUDGET_CHANNELS", "UPDATE_PROMOTION_TIMERANGE", "UPDATE_PROMOTION_BUDGET", "UPDATE_PROMOTION_TARGET", "UPDATE_PROMOTION_ADS", "CREATE_PROMOTION_ADS", "CREATE_PROMOTION_AD_FROM_SOCIAL_MEDIA_POST", "MANAGE_PROMOTION_AD_NAME", "MANAGE_PROMOTION_AD_CHANNELS", "MANAGE_PROMOTION_AD_PAGE", "MANAGE_PROMOTION_AD_MEDIA", "MANAGE_PROMOTION_AD_LINK", "MANAGE_PROMOTION_AD_CTA", "PUBLISH_SOCIAL_COMMENTS", "PUBLISH_REVIEW_REPLIES", "MANAGE_RESPONSE_TEMPLATES", "MANAGE_MODERATION_RULES", "REVIEW_AND_APPROVE_REPLIES", "DELETE_SOCIAL_COMMENTS", "MANAGE_REPORTS", "MANAGE_PROMOTION_AD_LINK_DESCRIPTION", "READ_POST", "WRITE_POST", "PUBLISH_POST", "REMOVE_PROMOTION_ADS", "MANAGE_PERSONAL_POSTS", "MANAGE_PAGE_POSTS", "MANAGE_STORIES", "MANAGE_PROMOTION_MARGIN", "GENERATE_POSTS", "GENERATE_CAMPAIGNS", "MANAGE_SUBTENANT_SETTINGS", "MANAGE_POST_TEMPLATES", "MANAGE_AD_TEMPLATES", "MANAGE_TARGETING_TEMPLATES", "IMPORT_POSTS", "IMPORT_CAMPAIGNS", "REVIEW_PROMOTION", "MANAGE_TOPICS", "TRANSLATE_POSTS", "MANAGE_LISTINGS", "MANAGE_LISTING_IMAGES", "MANAGE_LISTING_HOURS", "MANAGE_LISTING_NAME", "MANAGE_LISTING_STATUS", "MANAGE_LISTING_ADDRESS", "READ_SOCIAL_LISTENING_FEEDS", "MANAGE_MEDIA_ASSETS", "MANAGE_REPORTING_CALCULATED_FIELDS", "MANAGE_INFLUENCERS" ] } }, "filterable" : { "type" : "boolean" } } }, "Ad" : { "type" : "object", "properties" : { "adId" : { "type" : "string" }, "name" : { "type" : "string" }, "namingTemplateElementValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NamingTemplateElementValue" } }, "target" : { "$ref" : "#/components/schemas/AdTarget" }, "googleAdGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GoogleAdGroup" } }, "businessName" : { "type" : "string" }, "longTitle" : { "type" : "string" }, "adTextType" : { "type" : "string", "enum" : [ "TEXT_AD", "DYNAMIC_TEXT_AD", "CLICK_TO_CALL_AD", "SHOPPING_AD", "SHOPPING_SHOWCASE_AD" ] }, "textType" : { "type" : "string", "enum" : [ "SHORT", "LONG" ] }, "slides" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CarouselSlide" } }, "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdChannel" } }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "twitterUser" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "pinterestBoard" : { "$ref" : "#/components/schemas/Board" }, "utmTracking" : { "$ref" : "#/components/schemas/UtmTracking" }, "titles" : { "type" : "array", "items" : { "type" : "string" } }, "title2s" : { "type" : "array", "items" : { "type" : "string" } }, "title3s" : { "type" : "array", "items" : { "type" : "string" } }, "descriptions" : { "type" : "array", "items" : { "type" : "string" } }, "description2s" : { "type" : "array", "items" : { "type" : "string" } }, "pinnedTitles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinnedTextAsset" } }, "pinnedDescriptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinnedTextAsset" } }, "dynamicAdDescriptions1" : { "type" : "array", "items" : { "type" : "string" } }, "dynamicAdDescriptions2" : { "type" : "array", "items" : { "type" : "string" } }, "phoneNumber" : { "type" : "string" }, "countryCode" : { "type" : "string" }, "callOnlyDescriptions1" : { "type" : "array", "items" : { "type" : "string" } }, "callOnlyDescriptions2" : { "type" : "array", "items" : { "type" : "string" } }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "squareImages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "verticalImages" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "logos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "squareLogos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "links" : { "type" : "array", "items" : { "type" : "string" } }, "paths" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DisplayLinkPath" } }, "displayLinks" : { "type" : "array", "items" : { "type" : "string" } }, "linkDescriptions" : { "type" : "array", "items" : { "type" : "string" } }, "videos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "verticalVideos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "youTubeVideos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/YouTubeVideo" } }, "callToActions" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] } }, "facebookPostId" : { "type" : "string" }, "instagramPostId" : { "type" : "string" }, "twitterTweetId" : { "type" : "string" }, "linkedInPostId" : { "type" : "string" }, "pinterestPostId" : { "type" : "string" }, "searchAdType" : { "type" : "string", "enum" : [ "EXPANDED", "RESPONSIVE" ] }, "carouselMultiShareEndCard" : { "type" : "boolean" }, "carouselMultiShareOptimized" : { "type" : "boolean" }, "useTikTokSparkAd" : { "type" : "boolean" }, "tikTokProfileName" : { "type" : "string" }, "tikTokProfileImage" : { "$ref" : "#/components/schemas/Image" }, "adStatus" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "facebookAdGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookAdGroup" } }, "facebookInstantExperienceId" : { "type" : "string" }, "facebookInstantExperienceThumbnails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInstantExperienceThumbnail" } }, "tikTokPostId" : { "type" : "string" }, "youTubePostId" : { "type" : "string" }, "ignoredForDistribution" : { "type" : "boolean" }, "document" : { "$ref" : "#/components/schemas/Document" }, "deactivateComments" : { "type" : "boolean" }, "showMemberProfilePhoto" : { "type" : "boolean" }, "senderUrn" : { "type" : "string" }, "ctaLabel" : { "type" : "string" }, "eventUrl" : { "type" : "string" }, "adType" : { "type" : "string", "enum" : [ "TEXT", "IMAGE", "VIDEO", "SPOTLIGHT", "SHOPPING", "COLLECTION", "CAROUSEL", "DOCUMENT", "MESSAGE", "EVENT" ] }, "instagramCarouselPostBoosting" : { "type" : "boolean" }, "type" : { "type" : "string", "writeOnly" : true, "enum" : [ "SHORT", "LONG" ] } } }, "TeadsUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "ReportingBenchmark" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "datasource" : { "type" : "string", "enum" : [ "ALL", "POST", "CAMPAIGN", "CUSTOM_EVENT", "WEBSITE_ANALYTICS", "SOCIAL_MESSAGE", "EMAIL", "SEO", "TEADS", "LISTENING", "CUSTOM_DATASOURCE", "INFLUENCER", "PERSONAL_POST" ] }, "timeWindow" : { "type" : "string", "enum" : [ "ALL", "DAILY", "MONTHLY", "YEARLY" ] }, "segment" : { "type" : "string", "enum" : [ "NETWORK", "PLACEMENT", "SUBTENANT", "CAMPAIGN", "OBJECTIVE", "DAY", "MONTH", "QUARTER", "YEAR", "POST", "AD", "KEYWORD", "SEARCH_QUERIES", "CONVERSION", "CONVERSION_CATEGORY", "JOB_FUNCTION", "JOB_TITLE", "REGION", "COUNTRY", "INDUSTRY", "COMPANY", "ADGROUP", "AGE_RANGE", "GENDER", "WEBSITE_TRAFFIC_SOURCE", "WEBSITE_TRAFFIC_SOURCE_MEDIUM", "WEBSITE_TRAFFIC_REGION", "WEBSITE_TRAFFIC_CITY", "WEBSITE_LANDING_PAGE", "WEBSITE_PAGE_PATH", "WEBSITE_LANGUAGE", "WEBSITE_TRAFFIC_COUNTRY", "WEBSITE_TRAFFIC_DEVICE", "WEBSITE_TRAFFIC_CAMPAIGN", "CUSTOM", "TOPIC", "TAG", "POST_TEMPLATE", "WEEKDAY", "DEVICE", "LINKED_IN_PIVOT_COMPANY", "LINKED_IN_PIVOT_ACCOUNT", "LINKED_IN_PIVOT_SHARE", "LINKED_IN_PIVOT_CAMPAIGN", "LINKED_IN_PIVOT_CREATIVE", "LINKED_IN_PIVOT_CAMPAIGN_GROUP", "LINKED_IN_PIVOT_CONVERSION", "LINKED_IN_PIVOT_CONVERSATION_NODE", "LINKED_IN_PIVOT_CONVERSATION_NODE_OPTION_INDEX", "LINKED_IN_PIVOT_SERVING_LOCATION", "LINKED_IN_PIVOT_CARD_INDEX", "LINKED_IN_PIVOT_MEMBER_COMPANY_SIZE", "LINKED_IN_PIVOT_MEMBER_INDUSTRY", "LINKED_IN_PIVOT_MEMBER_SENIORITY", "LINKED_IN_PIVOT_MEMBER_JOB_TITLE", "LINKED_IN_PIVOT_MEMBER_JOB_FUNCTION", "LINKED_IN_PIVOT_MEMBER_COUNTRY_V2", "LINKED_IN_PIVOT_MEMBER_REGION_V2", "LINKED_IN_PIVOT_MEMBER_COMPANY", "LINKED_IN_PIVOT_PLACEMENT_NAME", "LINKED_IN_PIVOT_IMPRESSION_DEVICE_TYPE", "METRIC", "SEO_KEYWORD", "SEO_KEYWORD_OPPORTUNITIES", "SEO_COMPETITOR", "INSTAGRAM_FOLLOWER_DEMOGRAPHICS_COUNTRY", "INSTAGRAM_FOLLOWER_DEMOGRAPHICS_AGE", "INSTAGRAM_FOLLOWER_DEMOGRAPHICS_GENDER", "FACEBOOK_FOLLOWER_DEMOGRAPHICS_LANGUAGE", "FACEBOOK_FOLLOWER_DEMOGRAPHICS_COUNTRY", "MONITORED_PROFILE", "INFLUENCER", "ZIP_CODE_REGIONS", "A", "B", "C", "D", "E", "F", "G", "H", "I", "J", "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "EVENTS", "EVENTS_SOURCE_MEDIUM", "CONVERSIONS_PER_CAMPAIGN", "PRODUCTS", "USER" ] }, "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Field" } } } }, "TargetExclusion" : { "type" : "object", "properties" : { "facebookInterests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterest" } }, "linkedInTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } }, "googleKeywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GoogleKeyword" } }, "targetRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetRegion" } }, "retargeting" : { "$ref" : "#/components/schemas/Retargeting" }, "linkedInTargetingEntityLinkOperator" : { "type" : "string", "enum" : [ "AND", "OR" ] }, "twitterTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TwitterTargetingCriteria" } } } }, "BudgetChannelAutomationSettings" : { "type" : "object", "properties" : { "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "facebookCampaignId" : { "type" : "string" }, "targetAutomationSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetAutomationSettings" } }, "linkedInCampaignId" : { "type" : "string" }, "twitterCampaignId" : { "type" : "string" }, "tikTokCampaignId" : { "type" : "string" }, "pinterestCampaignId" : { "type" : "string" }, "linkedInCampaignGroupId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "previewContextInformation" : { "$ref" : "#/components/schemas/PreviewContextInformation" }, "active" : { "type" : "boolean" } } }, "UpdatePlacementStatusRequest" : { "type" : "object", "properties" : { "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] } } }, "PromotionPinterestAudience" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" } } }, "Budget" : { "type" : "object", "properties" : { "totalCost" : { "type" : "number", "format" : "double" }, "budgetChannels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BudgetChannel" } }, "overallMaxBid" : { "type" : "number", "format" : "double" }, "adWordsPageOneGoal" : { "type" : "string", "enum" : [ "ANY_POSITION", "TOP_POSITION" ] }, "higherThanCompetitorPercentage" : { "type" : "integer", "format" : "int32" }, "competitorDomain" : { "type" : "string" }, "targetCpa" : { "type" : "number", "format" : "double" }, "targetReturnOnAdSpendPercentage" : { "type" : "number", "format" : "double" }, "enhancedManualCpc" : { "type" : "boolean" }, "conversionTracking" : { "$ref" : "#/components/schemas/ConversionTracking" }, "biddingOptimization" : { "type" : "string", "enum" : [ "AUTOMATIC_CHANNELS", "MANUAL", "ENHANCED_CPC", "PAGE_ONE_PROMOTED", "TARGET_OUTRANK_SHARE", "TARGET_CPA", "TARGET_ROAS", "TARGET_SPEND", "MANUAL_CPV", "MANUAL_CPM", "UNKNOWN", "AUTOMATIC_ADHOOK", "MAXIMIZE_CONVERSIONS", "MAXIMIZE_CONVERSIONS_VALUE", "PERCENT_CPC", "TARGET_CPM", "TARGET_IMPRESSION_SHARE" ] }, "adWordsBiddingStrategyId" : { "type" : "string" }, "adWordsBiddingStrategyName" : { "type" : "string" }, "adWordsBiddingStrategyMode" : { "type" : "string", "enum" : [ "STANDARD", "PORTFOLIO" ] }, "deliveryMethod" : { "type" : "string", "enum" : [ "STANDARD", "ACCELERATED" ] }, "portfolioCreationMode" : { "type" : "string", "enum" : [ "EXISTING_PORTFOLIO", "NEW_PORTFOLIO" ] }, "marginSpecification" : { "type" : "string", "enum" : [ "NET", "GROSS" ] } } }, "Team" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "notificationMode" : { "type" : "string", "enum" : [ "NONE", "TEAM_EMAILS", "TEAM_MEMBERS" ] }, "emailAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "teamMembers" : { "type" : "array", "items" : { "type" : "string" } } } }, "YouTubeVideo" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "id" : { "type" : "string" } } }, "MonitoredKeyword" : { "type" : "object", "properties" : { "query" : { "type" : "string" } } }, "FlatDailyChannelDataPerDevice" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int32" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "cpa" : { "type" : "number", "format" : "double" }, "cpl" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "totallySpent" : { "type" : "number", "format" : "double" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "adChannelStatus" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "carouselSlideStatistics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CarouselSlideStatistic" } }, "date" : { "type" : "string" }, "device" : { "type" : "string", "enum" : [ "UNKNOWN", "DESKTOP", "HIGH_END_MOBILE", "TABLET", "MOBILE_WEB" ] }, "productOfferId" : { "type" : "string" }, "productCategories" : { "type" : "array", "items" : { "type" : "string" } }, "productTypes" : { "type" : "array", "items" : { "type" : "string" } }, "productBrand" : { "type" : "string" }, "adGroupId" : { "type" : "string" }, "retweets" : { "type" : "integer", "format" : "int32" }, "likes" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "reach" : { "type" : "integer", "format" : "int32" }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "results" : { "type" : "number", "format" : "double" }, "costPerResult" : { "type" : "number", "format" : "double" } } }, "TargetStatistic" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "id" : { "type" : "string" }, "targetId" : { "type" : "string" }, "targetName" : { "type" : "string" }, "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int32" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "cpa" : { "type" : "number", "format" : "double" }, "cpl" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "totallySpent" : { "type" : "number", "format" : "double" }, "promotionId" : { "type" : "string" }, "avgQualityScore" : { "type" : "number", "format" : "double" }, "likes" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "retweets" : { "type" : "integer", "format" : "int32" }, "postClicks" : { "type" : "integer", "format" : "int32" }, "postReactions" : { "type" : "integer", "format" : "int32" }, "postEngagements" : { "type" : "integer", "format" : "int32" }, "comments" : { "type" : "integer", "format" : "int32" }, "linkClicks" : { "type" : "integer", "format" : "int32" }, "landingPageViews" : { "type" : "integer", "format" : "int32" }, "costPerLinkClick" : { "type" : "number", "format" : "double" }, "linkClickCtr" : { "type" : "number", "format" : "double" }, "videoViews" : { "type" : "integer", "format" : "int32" }, "video25PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video50PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video75PercentCompletions" : { "type" : "integer", "format" : "int32" }, "videoCompletions" : { "type" : "integer", "format" : "int32" }, "thumbstopRate" : { "type" : "number", "format" : "double" }, "videoCompletionRate" : { "type" : "number", "format" : "double" }, "thruplays" : { "type" : "integer", "format" : "int32" }, "costPerThruplay" : { "type" : "number", "format" : "double" }, "targetStatsPerPlacement" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerPlacement" } }, "dailyStatistic" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerDay" } }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "results" : { "type" : "number", "format" : "double" }, "costPerResult" : { "type" : "number", "format" : "double" }, "messageSends" : { "type" : "integer", "format" : "int32" }, "messageOpens" : { "type" : "integer", "format" : "int32" }, "messageOpenRate" : { "type" : "number", "format" : "double" }, "reactions" : { "type" : "integer", "format" : "int64" } } }, "CallExtension" : { "type" : "object", "properties" : { "feedId" : { "type" : "integer", "format" : "int64" }, "feedItemId" : { "type" : "integer", "format" : "int64" }, "assetId" : { "type" : "integer", "format" : "int64" }, "adwordsCustomerId" : { "type" : "string" }, "extensionStatus" : { "type" : "string", "enum" : [ "ACCOUNT", "CAMPAIGN", "ADGROUP", "NONE" ] }, "extensionRunStatus" : { "type" : "string", "enum" : [ "ADDED_CAMPAIGN", "ADDED_ADGROUP", "ADDED_ACCOUNT", "IS_CAMPAIGN_LINKED", "IS_ADGROUP_LINKED", "UNLINKING", "UNLINKED" ] }, "phoneNumber" : { "type" : "string" }, "country" : { "type" : "string" } } }, "PromotionStatistic" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "id" : { "type" : "string" }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "promotionId" : { "type" : "string" }, "cost" : { "type" : "number", "format" : "double" }, "currency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int32" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "cpa" : { "type" : "number", "format" : "double" }, "cpl" : { "type" : "number", "format" : "double" }, "clicksPerDay" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerDay" } }, "likes" : { "type" : "integer", "format" : "int32" }, "postClicks" : { "type" : "integer", "format" : "int32" }, "postReactions" : { "type" : "integer", "format" : "int32" }, "postEngagements" : { "type" : "integer", "format" : "int32" }, "comments" : { "type" : "integer", "format" : "int32" }, "linkClicks" : { "type" : "integer", "format" : "int32" }, "landingPageViews" : { "type" : "integer", "format" : "int32" }, "costPerLinkClick" : { "type" : "number", "format" : "double" }, "linkClickCtr" : { "type" : "number", "format" : "double" }, "follows" : { "type" : "integer", "format" : "int32" }, "retweets" : { "type" : "integer", "format" : "int32" }, "reach" : { "type" : "integer", "format" : "int32" }, "totalReach" : { "type" : "integer", "format" : "int32" }, "videoViews" : { "type" : "integer", "format" : "int32" }, "video25PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video50PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video75PercentCompletions" : { "type" : "integer", "format" : "int32" }, "videoCompletions" : { "type" : "integer", "format" : "int32" }, "thumbstopRate" : { "type" : "number", "format" : "double" }, "videoCompletionRate" : { "type" : "number", "format" : "double" }, "thruplays" : { "type" : "integer", "format" : "int32" }, "videoWatched6s" : { "type" : "integer", "format" : "int32" }, "engagedView15s" : { "type" : "integer", "format" : "int32" }, "costPerThruplay" : { "type" : "number", "format" : "double" }, "messageSends" : { "type" : "integer", "format" : "int32" }, "messageOpens" : { "type" : "integer", "format" : "int32" }, "messageOpenRate" : { "type" : "number", "format" : "double" }, "audiencePenetration" : { "type" : "number", "format" : "double" }, "adwordsCampaignId" : { "type" : "string" }, "deviceStatistics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerPlacement" } }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "reactions" : { "type" : "integer", "format" : "int64" }, "calls" : { "type" : "integer", "format" : "int32" }, "likeClicks" : { "type" : "integer", "format" : "int32", "writeOnly" : true } } }, "UpdateAssigneeRequest" : { "type" : "object", "properties" : { "assigneeUserId" : { "type" : "string" }, "teamId" : { "type" : "string" }, "hint" : { "type" : "string" }, "ccUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "deliverContentTillDate" : { "type" : "string" }, "assignThread" : { "type" : "boolean" }, "assignOpenMessages" : { "type" : "boolean" }, "skipNotification" : { "type" : "boolean" } } }, "FacebookAdGroup" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "facebookInterests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterest" } }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "bid" : { "type" : "number", "format" : "double" }, "retargeting" : { "$ref" : "#/components/schemas/Retargeting" }, "devices" : { "$ref" : "#/components/schemas/Devices" } } }, "TwitterTargetingCriteria" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "KEYWORD", "FOLLOWER_LOOKALIKE" ] }, "value" : { "type" : "string" }, "twitterId" : { "type" : "string" } } }, "CampaignReviewConfiguration" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "promotionId" : { "type" : "string" }, "campaignReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "campaignCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "secondCampaignReviewStepEnabled" : { "type" : "boolean" }, "secondCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "campaignCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "thirdCampaignReviewStepEnabled" : { "type" : "boolean" }, "thirdCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "enforceManualApprovalForSelfCreatedCampaigns" : { "type" : "boolean" } } }, "TikTokTargetingCriteria" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "INTEREST_CATEGORY", "INTEREST_KEYWORD", "ACTION_CATEGORY_VIDEO", "ACTION_CATEGORY_CREATOR", "HASHTAG" ] }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TikTokTargetingCriteria" } } } }, "CompleteManualProcessTaskRequest" : { "type" : "object", "properties" : { "message" : { "type" : "string" }, "taskIsOk" : { "type" : "boolean" }, "skipReview" : { "type" : "boolean" }, "subtenantId" : { "type" : "string" }, "resubmitForShareable" : { "type" : "boolean" } } }, "AdStatistic" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "id" : { "type" : "string" }, "adId" : { "type" : "string" }, "adName" : { "type" : "string" }, "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int32" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "cpa" : { "type" : "number", "format" : "double" }, "cpl" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "totallySpent" : { "type" : "number", "format" : "double" }, "carouselSlideStatistics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CarouselSlideStatistic" } }, "adVariation" : { "$ref" : "#/components/schemas/AdVariation" }, "promotionId" : { "type" : "string" }, "currency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "targetId" : { "type" : "string" }, "targetName" : { "type" : "string" }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "adgroupId" : { "type" : "string" }, "adgroupName" : { "type" : "string" }, "dailyStatistic" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerDay" } }, "internalAdGroupId" : { "type" : "string" }, "productOfferId" : { "type" : "string" }, "productCategories" : { "type" : "array", "items" : { "type" : "string" } }, "productTypes" : { "type" : "array", "items" : { "type" : "string" } }, "productBrand" : { "type" : "string" }, "feedItemId" : { "type" : "string" }, "frequency" : { "type" : "number", "format" : "double" }, "relevanceScore" : { "type" : "integer", "format" : "int32" }, "retweets" : { "type" : "integer", "format" : "int32" }, "likes" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "reach" : { "type" : "integer", "format" : "int32" }, "totalReach" : { "type" : "integer", "format" : "int32" }, "postClicks" : { "type" : "integer", "format" : "int32" }, "postReactions" : { "type" : "integer", "format" : "int32" }, "postEngagements" : { "type" : "integer", "format" : "int32" }, "comments" : { "type" : "integer", "format" : "int32" }, "linkClicks" : { "type" : "integer", "format" : "int32" }, "costPerLinkClick" : { "type" : "number", "format" : "double" }, "linkClickCtr" : { "type" : "number", "format" : "double" }, "landingPageViews" : { "type" : "integer", "format" : "int32" }, "videoViews" : { "type" : "integer", "format" : "int32" }, "video25PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video50PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video75PercentCompletions" : { "type" : "integer", "format" : "int32" }, "videoCompletions" : { "type" : "integer", "format" : "int32" }, "messageSends" : { "type" : "integer", "format" : "int32" }, "messageOpens" : { "type" : "integer", "format" : "int32" }, "messageOpenRate" : { "type" : "number", "format" : "double" }, "thumbstopRate" : { "type" : "number", "format" : "double" }, "videoCompletionRate" : { "type" : "number", "format" : "double" }, "thruplays" : { "type" : "integer", "format" : "int32" }, "videoWatched6s" : { "type" : "integer", "format" : "int32" }, "engagedView15s" : { "type" : "integer", "format" : "int32" }, "costPerThruplay" : { "type" : "number", "format" : "double" }, "nbrOfSessions" : { "type" : "integer", "format" : "int32" }, "averageSessionDuration" : { "type" : "integer", "format" : "int32" }, "bounceRate" : { "type" : "number", "format" : "double" }, "users" : { "type" : "integer", "format" : "int32" }, "newUsers" : { "type" : "integer", "format" : "int32" }, "pageViewsPerSession" : { "type" : "number", "format" : "double" }, "engagedSessions" : { "type" : "integer", "format" : "int32" }, "screenPageViews" : { "type" : "integer", "format" : "int32" }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "disapprovedReasonText" : { "type" : "string" }, "results" : { "type" : "number", "format" : "double" }, "costPerResult" : { "type" : "number", "format" : "double" }, "cost" : { "type" : "number", "format" : "double" }, "reactions" : { "type" : "integer", "format" : "int64" }, "calls" : { "type" : "integer", "format" : "int32" } } }, "ThirdPartyPage" : { "type" : "object", "properties" : { "pictureUrl" : { "type" : "string" }, "name" : { "type" : "string" }, "id" : { "type" : "string" }, "search" : { "type" : "string" }, "userName" : { "type" : "string" }, "server" : { "type" : "string" } } }, "PromotionStatisticResult" : { "type" : "object", "properties" : { "statisticPerChannel" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PromotionStatistic" } } } }, "AdAutomationSettings" : { "type" : "object", "properties" : { "internalAdId" : { "type" : "string" }, "facebookAdId" : { "type" : "string" }, "facebookPostId" : { "type" : "string" }, "instagramMediaId" : { "type" : "string" }, "googleAdWordsAdId" : { "type" : "string" }, "googleAdWordsAdGroupId" : { "type" : "string" }, "facebookRelevanceScore" : { "type" : "integer", "format" : "int32" }, "instagramAdId" : { "type" : "string" }, "adVariation" : { "$ref" : "#/components/schemas/AdVariation" }, "targetId" : { "type" : "string" }, "targetName" : { "type" : "string" }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "googleAdWordsAdGroupName" : { "type" : "string" }, "internalAdGroupId" : { "type" : "string" }, "facebookAdGroupName" : { "type" : "string" }, "facebookAdGroupId" : { "type" : "string" }, "linkedInAdId" : { "type" : "string" }, "adInMailContentId" : { "type" : "string" }, "twitterAdId" : { "type" : "string" }, "tikTokAdId" : { "type" : "string" }, "pinterestAdId" : { "type" : "string" }, "createdAt" : { "type" : "string" } } }, "SnapchatAdAccount" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "currency" : { "type" : "string" } } }, "GoogleAdGroupExclusion" : { "type" : "object", "properties" : { "googleKeywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GoogleKeyword" } }, "retargeting" : { "$ref" : "#/components/schemas/Retargeting" } } }, "DisplayLinkPath" : { "type" : "object", "properties" : { "path1" : { "type" : "string" }, "path2" : { "type" : "string" } } }, "GoogleAdGroup" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "STANDARD", "DYNAMIC" ] }, "googleKeywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GoogleKeyword" } }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "bid" : { "type" : "number", "format" : "double" }, "targetCpa" : { "type" : "number", "format" : "double" }, "targetReturnOnAdSpendPercentage" : { "type" : "number", "format" : "double" }, "trackingUrlTemplate" : { "type" : "string" }, "customParameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomParameter" } }, "adGroupExclusion" : { "$ref" : "#/components/schemas/GoogleAdGroupExclusion" }, "retargeting" : { "$ref" : "#/components/schemas/Retargeting" }, "devices" : { "$ref" : "#/components/schemas/Devices" }, "extension" : { "$ref" : "#/components/schemas/Extension" }, "adRotationMode" : { "type" : "string", "enum" : [ "OPTIMIZE", "CONVERSION_OPTIMIZE", "ROTATE", "ROTATE_INDEFINITELY" ] }, "createdFromTargetingTemplateId" : { "type" : "string" } } }, "SpecialDate" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "open" : { "type" : "boolean" }, "openTime" : { "type" : "string" }, "closeTime" : { "type" : "string" } } }, "FacebookProductCatalog" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "nbrOfProducts" : { "type" : "integer", "format" : "int32" }, "nbrOfQualifiedProducts" : { "type" : "integer", "format" : "int32" } } }, "FileAttachment" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "url" : { "type" : "string" }, "fileExtension" : { "type" : "string" }, "mediaAssetId" : { "type" : "string" } } }, "PromotionReactivationRequest" : { "type" : "object", "properties" : { "end" : { "type" : "string" }, "budgetChannels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BudgetChannel" } } } }, "PromotionFacebookCustomAudience" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" } } }, "Devices" : { "type" : "object", "properties" : { "showOnMobile" : { "type" : "boolean" }, "showOnTablet" : { "type" : "boolean" }, "showOnDesktop" : { "type" : "boolean" }, "mobileBidModifier" : { "type" : "number", "format" : "double" }, "mobileBidModifierType" : { "type" : "string", "enum" : [ "INCREASE", "DECREASE" ] }, "tabletBidModifier" : { "type" : "number", "format" : "double" }, "tabletBidModifierType" : { "type" : "string", "enum" : [ "INCREASE", "DECREASE" ] }, "desktopBidModifier" : { "type" : "number", "format" : "double" }, "desktopBidModifierType" : { "type" : "string", "enum" : [ "INCREASE", "DECREASE" ] } } }, "InfluencerPost" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "influencerId" : { "type" : "string" }, "date" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "views" : { "type" : "integer", "format" : "int64" }, "engagements" : { "type" : "integer", "format" : "int64" }, "likes" : { "type" : "integer", "format" : "int64" }, "comments" : { "type" : "integer", "format" : "int64" }, "shares" : { "type" : "integer", "format" : "int64" }, "postLink" : { "type" : "string" }, "collaborationId" : { "type" : "string" }, "cost" : { "$ref" : "#/components/schemas/InfluencerCost" }, "createdAt" : { "type" : "string" }, "updatedAt" : { "type" : "string" } } }, "MediaItemBatchRequest" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ListingChannel" } }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MediaItemUploadRequest" } } } }, "GoogleUser" : { "type" : "object", "properties" : { "emailAddress" : { "type" : "string" }, "googleCredentials" : { "type" : "string" }, "customerId" : { "type" : "string" }, "mccCustomerId" : { "type" : "string" }, "analyticsProfileId" : { "type" : "string" }, "analyticsType" : { "type" : "string", "enum" : [ "UNIVERSAL", "GA4" ] }, "name" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "youTubeChannelId" : { "type" : "string" }, "expiresInSeconds" : { "type" : "integer", "format" : "int64" }, "refreshToken" : { "type" : "string" } } }, "TargetSchedule" : { "type" : "object", "properties" : { "start" : { "type" : "string", "format" : "date-time" }, "end" : { "type" : "string", "format" : "date-time" }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "targetId" : { "type" : "string" } } }, "PinnedTextAsset" : { "type" : "object", "properties" : { "textAssetIndex" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "string", "enum" : [ "NOT_PINNED", "POSITION_1", "POSITION_2", "POSITION_3" ] } } }, "Influencer" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE", "ARCHIVED" ] }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "socialHandle" : { "type" : "string" }, "profiles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InfluencerProfile" } }, "goals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InfluencerGoal" } }, "documents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InfluencerDocument" } }, "defaultPromotedProduct" : { "type" : "string" }, "posts" : { "type" : "integer", "format" : "int64" }, "engagements" : { "type" : "integer", "format" : "int64" }, "views" : { "type" : "integer", "format" : "int64" }, "postLink" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "updatedAt" : { "type" : "string" } } }, "Milestone" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "date" : { "type" : "string" }, "relatedTopicIds" : { "type" : "array", "items" : { "type" : "string" } }, "createdAt" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" } } }, "PromotionTwitterMatchedAudience" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" } } }, "ReachEstimateRequest" : { "type" : "object", "properties" : { "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "promotionId" : { "type" : "string" }, "target" : { "$ref" : "#/components/schemas/Target" }, "budgetChannel" : { "$ref" : "#/components/schemas/BudgetChannel" }, "adAccountId" : { "type" : "string" } } }, "AutomaticPostPromotion" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "name" : { "type" : "string" }, "target" : { "$ref" : "#/components/schemas/AdTarget" }, "platforms" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } }, "postType" : { "type" : "string", "enum" : [ "ALL", "LINK", "IMAGE", "VIDEO" ] }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "maxPostPublishedDateInDays" : { "type" : "integer", "format" : "int32" }, "postMessageKeywords" : { "type" : "array", "items" : { "type" : "string" } }, "minimumOrganicResultMetric" : { "type" : "string", "enum" : [ "CLICKS", "LIKES", "IMPRESSIONS", "REACH" ] }, "minimumOrganicResultValue" : { "type" : "integer", "format" : "int32" }, "placements" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] } }, "customLinkParams" : { "type" : "string" } } }, "UploadVideoRequest" : { "type" : "object", "properties" : { "promotionId" : { "type" : "string" }, "video" : { "$ref" : "#/components/schemas/Video" }, "sourceInstagramMediaId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "adAccountId" : { "type" : "string" } } }, "TimeRange" : { "type" : "object", "properties" : { "start" : { "type" : "string", "format" : "date-time" }, "end" : { "type" : "string", "format" : "date-time" }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "durationType" : { "type" : "string", "enum" : [ "SHORT_TERM", "LONG_TERM" ] }, "targetSchedule" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetSchedule" } } } }, "TargetAutomationSettings" : { "type" : "object", "properties" : { "internalTargetId" : { "type" : "string" }, "adWordsCampaignId" : { "type" : "string" }, "facebookAdSetId" : { "type" : "string" }, "instagramAdSetId" : { "type" : "string" }, "facebookInstagramStoryAdSetId" : { "type" : "string" }, "facebookInstagramReelAdSetId" : { "type" : "string" }, "tikTokAdGroupId" : { "type" : "string" }, "pinterestAdGroupId" : { "type" : "string" }, "lastOptimizationRun" : { "type" : "string", "format" : "date-time" }, "lastBudgetOptimizationRun" : { "type" : "string", "format" : "date-time" }, "adAutomationSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdAutomationSettings" } }, "adGroupAutomationSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdGroupAutomationSettings" } }, "adWordsBudgetId" : { "type" : "string" }, "adWordsAdGroupId" : { "type" : "string" }, "internalTargetName" : { "type" : "string" }, "bid" : { "type" : "number", "format" : "double" }, "avgQualityScore" : { "type" : "number", "format" : "double" }, "twitterLineItemId" : { "type" : "string" }, "googleAdsKeywordPlanId" : { "type" : "integer", "format" : "int64" }, "linkedInCampaignId" : { "type" : "string" }, "createdFromPostId" : { "type" : "string" }, "allAdGroupIds" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "BulkReorderTasksRequest" : { "type" : "object", "properties" : { "tasks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TaskOrderUpdate" } } } }, "ActivatePromotionRequest" : { "type" : "object", "properties" : { "reviewMessage" : { "type" : "string" } } }, "Video" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "originalUrl" : { "type" : "string" }, "fileName" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int32" }, "originalSize" : { "type" : "integer", "format" : "int64" }, "fileExtension" : { "type" : "string" }, "facebookVideoId" : { "type" : "string" }, "tikTokVideoId" : { "type" : "string" }, "width" : { "type" : "integer", "format" : "int32" }, "height" : { "type" : "integer", "format" : "int32" }, "duration" : { "type" : "number", "format" : "double" }, "hasAudio" : { "type" : "boolean" }, "thumbnailImage" : { "$ref" : "#/components/schemas/Image" }, "thumbnailTimePosition" : { "type" : "number", "format" : "double" }, "cutStartTimePosition" : { "type" : "number", "format" : "double" }, "cutEndTimePosition" : { "type" : "number", "format" : "double" }, "cutUrl" : { "type" : "string" }, "compressedVideoUrl" : { "type" : "string" }, "justOptimized" : { "type" : "boolean" }, "mediaStatus" : { "type" : "string", "enum" : [ "ALL", "CREATED", "IN_PROGRESS", "NEEDS_REVIEW", "APPROVED", "CHECK_FEEDBACK", "READY", "PROCESSING", "DELETED" ] }, "mediaVideoId" : { "type" : "string" }, "title" : { "type" : "string" }, "order" : { "type" : "integer", "format" : "int32" }, "productTags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProductTag" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VideoTag" } }, "mediaAssetId" : { "type" : "string" }, "bitrateBps" : { "type" : "integer", "format" : "int64" }, "metadataStatus" : { "type" : "string", "enum" : [ "PENDING", "FINISHED", "FAILED" ] }, "videoCodec" : { "type" : "string" }, "audioCodec" : { "type" : "string" } } }, "LeadForm" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" } } }, "SubtenantUpdateModel" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE" ] }, "googleUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "googleAnalyticsUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "googleMyBusinessLocation" : { "$ref" : "#/components/schemas/GoogleMyBusinessLocation" }, "facebookUser" : { "$ref" : "#/components/schemas/FacebookUser" }, "linkedInUser" : { "$ref" : "#/components/schemas/LinkedInUser" }, "linkedInPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "linkedInDefaultCampaignGroup" : { "$ref" : "#/components/schemas/CampaignGroup" }, "twitterUser" : { "$ref" : "#/components/schemas/TwitterUser" }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "instagramAccount" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "hideFacebook" : { "type" : "boolean" }, "twitterProfile" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "allowLongerXPosts" : { "type" : "boolean" }, "tikTokBusinessUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokProfileName" : { "type" : "string" }, "tikTokProfileImage" : { "$ref" : "#/components/schemas/Image" }, "youTubeUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "targetRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetRegion" } }, "parentSubtenantId" : { "type" : "string" }, "statisticNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticNotification" } }, "color" : { "type" : "string" }, "linkedInAccountCurrency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "authorizationGroup" : { "$ref" : "#/components/schemas/Group" }, "language" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] }, "languages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "website" : { "type" : "string" }, "variables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Variable" } }, "reportingBenchmarks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportingBenchmark" } }, "googleRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "skippablePostReview" : { "type" : "boolean" }, "postReviewUserId" : { "type" : "string" }, "postReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "campaignReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "secondPostReviewStepEnabled" : { "type" : "boolean" }, "secondCampaignReviewStepEnabled" : { "type" : "boolean" }, "secondPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "secondCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "thirdPostReviewStepEnabled" : { "type" : "boolean" }, "thirdCampaignReviewStepEnabled" : { "type" : "boolean" }, "thirdPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "thirdCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "enforceManualApprovalForSelfCreatedPosts" : { "type" : "boolean" }, "skipManualApprovalForPostWithoutPromotion" : { "type" : "boolean" }, "allowInstagram" : { "type" : "boolean" }, "postTargeting" : { "$ref" : "#/components/schemas/PostTargeting" }, "responsibleUserId" : { "type" : "string" }, "marginPercentage" : { "type" : "number", "format" : "double" }, "marginPerChannel" : { "type" : "boolean" }, "googleMarginPercentage" : { "type" : "number", "format" : "double" }, "facebookMarginPercentage" : { "type" : "number", "format" : "double" }, "linkedInMarginPercentage" : { "type" : "number", "format" : "double" }, "twitterMarginPercentage" : { "type" : "number", "format" : "double" }, "tikTokMarginPercentage" : { "type" : "number", "format" : "double" }, "primary" : { "type" : "boolean" }, "advertisingEnabled" : { "type" : "boolean" }, "postPublishingEnabled" : { "type" : "boolean" }, "postGenerationEnabled" : { "type" : "boolean" }, "campaignGenerationEnabled" : { "type" : "boolean" }, "automaticPostImportEnabled" : { "type" : "boolean" }, "automaticCampaignImportEnabled" : { "type" : "boolean" }, "postTargetingEnabled" : { "type" : "boolean" }, "needsSelectedTopicForPosts" : { "type" : "boolean" }, "hideFirstComment" : { "type" : "boolean" }, "hideManualPublishingOptions" : { "type" : "boolean" }, "hideTags" : { "type" : "boolean" }, "hideRemark" : { "type" : "boolean" }, "hideExtendedPostPromotionSettings" : { "type" : "boolean" }, "suspendPostPublishing" : { "type" : "boolean" }, "fixedNumberOfDaysForPostBoosting" : { "type" : "integer", "format" : "int32" }, "fixedBoostingBudget" : { "type" : "integer", "format" : "int32" }, "boostingCampaignNamePlaceholder" : { "type" : "string" }, "boostingAdNamePlaceholder" : { "type" : "string" }, "adCommentModerationEnabled" : { "type" : "boolean" }, "postCommentModerationEnabled" : { "type" : "boolean" }, "adCommentDefaultAssigneeUserId" : { "type" : "string" }, "postCommentDefaultAssigneeUserId" : { "type" : "string" }, "adCommentDefaultAssigneeTeamId" : { "type" : "string" }, "postCommentDefaultAssigneeTeamId" : { "type" : "string" }, "mentionModerationEnabled" : { "type" : "boolean" }, "messageModerationEnabled" : { "type" : "boolean" }, "reviewModerationEnabled" : { "type" : "boolean" }, "adCommentNotificationEnabled" : { "type" : "boolean" }, "postCommentNotificationEnabled" : { "type" : "boolean" }, "mentionNotificationEnabled" : { "type" : "boolean" }, "messageNotificationEnabled" : { "type" : "boolean" }, "reviewNotificationEnabled" : { "type" : "boolean" }, "hashtagNotificationEnabled" : { "type" : "boolean" }, "linkedInFollowerBreakdownByCountry" : { "type" : "boolean" }, "facebookFollowerBreakdownByCountry" : { "type" : "boolean" }, "adBeneficiary" : { "type" : "string" }, "adPayor" : { "type" : "string" }, "facebookCustomLinkParams" : { "type" : "string" }, "instagramCustomLinkParams" : { "type" : "string" }, "linkedInCustomLinkParams" : { "type" : "string" }, "tikTokCustomLinkParams" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "socialMessageBlacklists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SocialMessageBlacklist" } }, "ccModerationNotificationUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "ccModerationNotificationScopes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "AD_COMMENTS", "POST_COMMENTS", "MENTIONS", "DIRECT_MESSAGES", "REVIEWS" ] } }, "netiquettePolicyEnabled" : { "type" : "boolean" }, "netiquettePolicy" : { "$ref" : "#/components/schemas/NetiquettePolicy" }, "businessHours" : { "$ref" : "#/components/schemas/BrandBusinessHours" }, "hashtagMonitoring" : { "$ref" : "#/components/schemas/HashtagMonitoring" }, "keywordMonitoring" : { "$ref" : "#/components/schemas/KeywordMonitoring" }, "profileMonitoring" : { "$ref" : "#/components/schemas/ProfileMonitoring" }, "newsMonitoring" : { "$ref" : "#/components/schemas/NewsMonitoring" }, "allowAddingLinksToBio" : { "type" : "boolean" }, "sendNotificationOnPostPublicationDefault" : { "type" : "boolean" }, "threadsUser" : { "$ref" : "#/components/schemas/ThreadsUser" }, "whatsAppUser" : { "$ref" : "#/components/schemas/WhatsAppUser" }, "blueskyUser" : { "$ref" : "#/components/schemas/BlueskyUser" }, "pinterestUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "pinterestAdUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "canvaUser" : { "$ref" : "#/components/schemas/CanvaUser" }, "canvaFolderId" : { "type" : "string" }, "hubSpotUser" : { "$ref" : "#/components/schemas/HubSpotUser" }, "salesForceUser" : { "$ref" : "#/components/schemas/SalesForceUser" }, "brevoUser" : { "$ref" : "#/components/schemas/BrevoUser" }, "sistrixUser" : { "$ref" : "#/components/schemas/SistrixUser" }, "beekeeperUser" : { "$ref" : "#/components/schemas/BeekeeperUser" }, "teadsUser" : { "$ref" : "#/components/schemas/TeadsUser" }, "mastodonUser" : { "$ref" : "#/components/schemas/MastodonUser" }, "snapchatUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "snapchatAdUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "pixxioUser" : { "$ref" : "#/components/schemas/PixxioUser" }, "cantoUser" : { "$ref" : "#/components/schemas/CantoUser" }, "adCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "postCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "mentionNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "messageNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "reviewNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "hashtagNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "listeningNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ListeningNotification" } }, "subtenantCategoryId" : { "type" : "string" }, "allowShareableApprovalLink" : { "type" : "boolean" }, "xcustomLinkParams" : { "type" : "string" } } }, "BeekeeperPostLabel" : { "type" : "object", "properties" : { "text" : { "type" : "string" } } }, "InfluencerDocument" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "url" : { "type" : "string" }, "fileType" : { "type" : "string" }, "size" : { "type" : "integer", "format" : "int64" }, "uploadedAt" : { "type" : "string" } } }, "ChannelStatisticResult" : { "type" : "object", "properties" : { "statisticPerChannel" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChannelStatistic" } } } }, "ImageTag" : { "type" : "object", "properties" : { "x" : { "type" : "number", "format" : "double" }, "y" : { "type" : "number", "format" : "double" }, "name" : { "type" : "string" } } }, "FcmDeviceTokenRequest" : { "type" : "object", "properties" : { "deviceToken" : { "type" : "string" }, "platform" : { "type" : "string" } } }, "CanvaUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string" }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" } } }, "InfluencerCollaboration" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "influencerId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "COMPLETED" ] }, "startDate" : { "type" : "string" }, "endDate" : { "type" : "string" }, "briefingHtml" : { "type" : "string" }, "promotedProduct" : { "type" : "string" }, "goals" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InfluencerGoal" } }, "cost" : { "$ref" : "#/components/schemas/InfluencerCost" }, "createdAt" : { "type" : "string" }, "updatedAt" : { "type" : "string" } } }, "PollSettings" : { "type" : "object", "properties" : { "voteSelectionType" : { "type" : "string", "enum" : [ "SINGLE_VOTE", "MULTIPLE_VOTE" ] }, "duration" : { "type" : "string", "enum" : [ "FIVE_MINUTES", "THIRTY_MINUTES", "ONE_HOUR", "SIX_HOURS", "TWELVE_HOURS", "ONE_DAY", "THREE_DAYS", "SEVEN_DAYS", "FOURTEEN_DAYS" ] }, "voterVisibleToAuthor" : { "type" : "boolean" } } }, "TargetBudget" : { "type" : "object", "properties" : { "targetId" : { "type" : "string" }, "budget" : { "type" : "number", "format" : "double" }, "linkedInDailyBudget" : { "type" : "number", "format" : "double" }, "metaBudgetSplit" : { "$ref" : "#/components/schemas/MetaBudgetSplit" } } }, "Field" : { "type" : "object", "properties" : { "key" : { "type" : "string", "enum" : [ "NAME", "IMPRESSIONS", "ORGANIC_IMPRESSIONS", "PAID_IMPRESSIONS", "CLICKS", "ORGANIC_CLICKS", "PAID_CLICKS", "PAID_LINK_CLICKS", "COST", "INFLUENCER_COST", "CONVERSIONS", "LEADS", "CONVERSION_VALUE", "ALL_CONVERSIONS", "CTR", "CPC", "CPA", "CPL", "CPV", "CONVERSION_RATE", "RETWEETS", "LIKES", "FOLLOWS", "REACH", "ORGANIC_REACH", "PAID_REACH", "FOLLOWER_REACH", "NON_FOLLOWER_REACH", "SHARES", "POST_REACTIONS", "POST_ENGAGEMENTS", "COMMENTS", "LINK_CLICKS", "COST_PER_LINK_CLICK", "LANDING_PAGE_VIEWS", "LINK_CLICK_CTR", "VIDEO_VIEWS", "ESTIMATED_MINUTES_WATCHED", "PAGE_VIEWS", "ORGANIC_VIDEO_VIEWS", "PAID_VIDEO_VIEWS", "VIDEO_25_PERCENT_COMPLETIONS", "VIDEO_50_PERCENT_COMPLETIONS", "VIDEO_75_PERCENT_COMPLETIONS", "VIDEO_COMPLETIONS", "COST_PER_VIDEO_25_PERCENT_COMPLETION", "COST_PER_VIDEO_50_PERCENT_COMPLETION", "COST_PER_VIDEO_75_PERCENT_COMPLETION", "COST_PER_VIDEO_COMPLETION", "SESSIONS", "SESSION_DURATION", "USER_ENGAGEMENT_DURATION", "BOUNCE_RATE", "USERS", "NEW_USERS", "PAGE_VIEWS_PER_SESSION", "CPM", "REACTIONS", "NUMBER_OF_CAMPAIGNS", "FOLLOWERS", "FACEBOOK_FOLLOWERS", "INSTAGRAM_FOLLOWERS", "LINKEDIN_FOLLOWERS", "TWITTER_FOLLOWERS", "YOUTUBE_FOLLOWERS", "TIKTOK_FOLLOWERS", "BLUESKY_FOLLOWERS", "THREADS_FOLLOWERS", "PINTEREST_FOLLOWERS", "MASTODON_FOLLOWERS", "SNAPCHAT_FOLLOWERS", "MEDIA_URL", "NUMBER_OF_POSTS", "NUMBER_OF_UNIQUE_POSTS", "NUMBER_OF_VIDEO_POSTS", "NUMBER_OF_IMAGE_POSTS", "CHANNEL", "CAMPAIGN", "ADGROUP", "SUBTENANT", "CONVERSION_CATEGORY", "EXTERNAL_OBJECT_URL", "TAPS_FORWARD", "TAPS_BACK", "REPLIES", "EXITS", "RESULTS", "COST_PER_RESULT", "COST_PER_REACH", "COST_PER_ENGAGEMENT", "PUBLISHED_AT", "CUSTOM_FIELD", "CALCULATED_FIELD", "NUMBER_OF_TOTAL_ACTIVITIES", "NUMBER_OF_EMAIL_CAMPAIGN_ACTIVITIES", "NUMBER_OF_PRINT_CAMPAIGN_ACTIVITIES", "NUMBER_OF_PRESS_RELEASE_ACTIVITIES", "NUMBER_OF_INTERNAL_COMMUNICATION_ACTIVITIES", "NUMBER_OF_OTHER_ACTIVITIES", "NUMBER_OF_EVENT_ACTIVITIES", "NUMBER_OF_ONLINE_PLATFORM_ACTIVITIES", "NUMBER_OF_ADVERTISING_ACTIVITIES", "NUMBER_OF_BLOG_ACTIVITIES", "NUMBER_OF_STORIES", "ENGAGEMENT_RATE", "ORGANIC_SEARCH_IMPRESSIONS", "ORGANIC_SEARCH_CLICKS", "NUMBER_OF_SOCIAL_MESSAGES", "NUMBER_OF_SOCIAL_MESSAGE_REPLIES", "NUMBER_OF_SOCIAL_MESSAGES_WITH_INTENTION", "NUMBER_OF_SOCIAL_MESSAGES_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_SOCIAL_MESSAGES", "NUMBER_OF_NEUTRAL_SOCIAL_MESSAGES", "NUMBER_OF_NEGATIVE_SOCIAL_MESSAGES", "NUMBER_OF_COMMENTS", "NUMBER_OF_COMMENT_REPLIES", "NUMBER_OF_COMMENTS_WITH_INTENTION", "NUMBER_OF_COMMENTS_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_COMMENTS", "NUMBER_OF_NEUTRAL_COMMENTS", "NUMBER_OF_NEGATIVE_COMMENTS", "NUMBER_OF_POST_COMMENTS", "NUMBER_OF_POST_COMMENT_REPLIES", "NUMBER_OF_POST_COMMENTS_WITH_INTENTION", "NUMBER_OF_POST_COMMENTS_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_POST_COMMENTS", "NUMBER_OF_NEUTRAL_POST_COMMENTS", "NUMBER_OF_NEGATIVE_POST_COMMENTS", "NUMBER_OF_AD_COMMENTS", "NUMBER_OF_AD_COMMENT_REPLIES", "NUMBER_OF_AD_COMMENTS_WITH_INTENTION", "NUMBER_OF_AD_COMMENTS_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_AD_COMMENTS", "NUMBER_OF_NEUTRAL_AD_COMMENTS", "NUMBER_OF_NEGATIVE_AD_COMMENTS", "NUMBER_OF_MENTIONS", "NUMBER_OF_MENTIONS_WITH_INTENTION", "NUMBER_OF_MENTIONS_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_MENTIONS", "NUMBER_OF_NEUTRAL_MENTIONS", "NUMBER_OF_NEGATIVE_MENTIONS", "NUMBER_OF_DIRECT_MESSAGES", "NUMBER_OF_DIRECT_MESSAGE_REPLIES", "NUMBER_OF_DIRECT_MESSAGES_WITH_INTENTION", "NUMBER_OF_DIRECT_MESSAGES_WITH_NO_INTENTION", "NUMBER_OF_POSITIVE_DIRECT_MESSAGES", "NUMBER_OF_NEUTRAL_DIRECT_MESSAGES", "NUMBER_OF_NEGATIVE_DIRECT_MESSAGES", "NUMBER_OF_REVIEWS", "NUMBER_OF_REVIEW_REPLIES", "NUMBER_OF_REVIEWS_WITH_INTENTION", "NUMBER_OF_REVIEWS_WITH_NO_INTENTION", "NUMBER_OF_REVIEWS_WITH_COMMENT", "NUMBER_OF_POSITIVE_REVIEWS", "NUMBER_OF_NEUTRAL_REVIEWS", "NUMBER_OF_NEGATIVE_REVIEWS", "NUMBER_OF_1STAR_REVIEWS", "NUMBER_OF_1STAR_REVIEW_REPLIES", "NUMBER_OF_2STAR_REVIEWS", "NUMBER_OF_2STAR_REVIEW_REPLIES", "NUMBER_OF_3STAR_REVIEWS", "NUMBER_OF_3STAR_REVIEW_REPLIES", "NUMBER_OF_4STAR_REVIEWS", "NUMBER_OF_4STAR_REVIEW_REPLIES", "NUMBER_OF_5STAR_REVIEWS", "NUMBER_OF_5STAR_REVIEW_REPLIES", "GOAL", "TAGS", "TOPICS", "START", "END", "VIDEO_VIEW_RATE", "FULL_VIDEO_WATCHED_RATE", "TOTAL_TIME_WATCHED", "AVERAGE_TIME_WATCHED", "DAILY_FOLLOWERS", "DAILY_FACEBOOK_FOLLOWERS", "DAILY_INSTAGRAM_FOLLOWERS", "DAILY_LINKEDIN_FOLLOWERS", "DAILY_TWITTER_FOLLOWERS", "DAILY_YOUTUBE_FOLLOWERS", "DAILY_TIKTOK_FOLLOWERS", "DAILY_BLUESKY_FOLLOWERS", "DAILY_THREADS_FOLLOWERS", "DAILY_PINTEREST_FOLLOWERS", "DAILY_MASTODON_FOLLOWERS", "SNAPCHAT_FOLLOWER_GROWTH_RATE", "REACTIONS_PER_POST", "IMPRESSIONS_PER_POST", "ORGANIC_IMPRESSIONS_PER_POST", "ORGANIC_REACH_PER_POST", "ORGANIC_CLICKS_PER_POST", "CLICKS_PER_POST", "DAILY_SESSIONS", "DAILY_USERS", "DAILY_NEW_USERS", "CAMPAIGN_BUDGET", "ADGROUP_BUDGET", "CAMPAIGN_STATUS", "CONTENT_TITLE", "CONTENT_TEXT", "CONTENT_LINK", "FACEBOOK_PAGE_LIKES", "PURCHASE_REVENUE", "AVERAGE_PURCHASE_REVENUE", "PURCHASES", "AVERAGE_GOOGLE_RATING", "TOTAL_REVIEW_COUNT", "POST_ENGAGEMENT_RATE", "POST_REACH_ENGAGEMENT_RATE", "ORGANIC_POST_ENGAGEMENT_RATE", "ORGANIC_POST_REACH_ENGAGEMENT_RATE", "REMARK", "CAMPAIGN_DURATION_DAYS", "THUMBSTOP_RATE", "ENGAGEMENTS_PER_FOLLOWERS", "ORGANIC_IMPRESSIONS_PER_FOLLOWERS", "VIDEO_COMPLETION_RATE", "FOLLOWER_GROWTH_RATE", "FACEBOOK_FOLLOWER_GROWTH_RATE", "INSTAGRAM_FOLLOWER_GROWTH_RATE", "LINKED_IN_FOLLOWER_GROWTH_RATE", "TWITTER_FOLLOWER_GROWTH_RATE", "YOUTUBE_FOLLOWER_GROWTH_RATE", "TIKTOK_FOLLOWER_GROWTH_RATE", "BLUESKY_FOLLOWER_GROWTH_RATE", "THREADS_FOLLOWER_GROWTH_RATE", "PINTEREST_FOLLOWER_GROWTH_RATE", "MASTODON_FOLLOWER_GROWTH_RATE", "DAILY_SNAPCHAT_FOLLOWERS", "SENT_EMAILS", "OPENED_EMAILS", "UNSUBSCRIPTIONS", "UNSUBSCRIBE_RATE", "OPEN_RATE", "SEO_VISIBILITY_INDEX", "SEO_KEYWORD_COUNT", "SEO_KEYWORD_COUNT_TOP10", "SEO_URL", "SEO_POSITION", "POST_SAVES", "THRUPLAYS", "COST_PER_THRUPLAY", "COST_PER_LANDING_PAGE_VIEW", "FREQUENCY", "REACH_RATE", "APPLAUSE_RATE", "MESSAGE_OPEN_RATE", "MESSAGE_SENDS", "MESSAGE_OPENS", "VTR", "RANK", "LOCATION", "SUBTENANT_CATEGORY", "CONVERSION_ACTION", "VIDEO_WATCHED_6S", "ENGAGED_VIEWS_15S", "AUDIENCE_PENETRATION" ] }, "customFieldName" : { "type" : "string" }, "order" : { "type" : "integer", "format" : "int32" } } }, "SpecialHours" : { "type" : "object", "properties" : { "dates" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SpecialDate" } } } }, "SistrixUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "key" : { "type" : "string" } } }, "PollOption" : { "type" : "object", "properties" : { "text" : { "type" : "string" }, "voteCount" : { "type" : "integer", "format" : "int64" }, "votedByViewer" : { "type" : "boolean" } } }, "TwitterUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "accessTokenSecret" : { "type" : "string" }, "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" } } }, "Age" : { "type" : "object", "properties" : { "value" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "AdvancedTikTokSettings" : { "type" : "object", "properties" : { "brandOrganic" : { "type" : "boolean" }, "brandedContent" : { "type" : "boolean" }, "disableComment" : { "type" : "boolean" }, "disableDuet" : { "type" : "boolean" }, "disableStitch" : { "type" : "boolean" }, "aiGenerated" : { "type" : "boolean" }, "autoAddMusic" : { "type" : "boolean" }, "photoCoverIndex" : { "type" : "integer", "format" : "int32" } } }, "MediaItemUploadRequest" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "name" : { "type" : "string" }, "fileExtension" : { "type" : "string" } } }, "CalloutExtension" : { "type" : "object", "properties" : { "feedId" : { "type" : "integer", "format" : "int64" }, "feedItemId" : { "type" : "integer", "format" : "int64" }, "assetId" : { "type" : "integer", "format" : "int64" }, "adwordsCustomerId" : { "type" : "string" }, "extensionStatus" : { "type" : "string", "enum" : [ "ACCOUNT", "CAMPAIGN", "ADGROUP", "NONE" ] }, "extensionRunStatus" : { "type" : "string", "enum" : [ "ADDED_CAMPAIGN", "ADDED_ADGROUP", "ADDED_ACCOUNT", "IS_CAMPAIGN_LINKED", "IS_ADGROUP_LINKED", "UNLINKING", "UNLINKED" ] }, "calloutText" : { "type" : "string" } } }, "AppendAdsRequest" : { "type" : "object", "properties" : { "imageAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "textAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "videoAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "collectionAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "carouselAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "documentAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "shoppingAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } } } }, "Post" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" }, "assigneeUserId" : { "type" : "string" }, "assigneeUserEmail" : { "type" : "string" }, "translationUserId" : { "type" : "string" }, "translationUserEmail" : { "type" : "string" }, "translationStatus" : { "type" : "string", "enum" : [ "IN_PROGRESS", "COMPLETED" ] }, "translationDate" : { "type" : "string" }, "deliverContentTillDate" : { "type" : "string" }, "reviewTillDate" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "PERSONAL_POST", "PAGE_POST", "STORY", "REELS", "SHORTS", "LINK_CAROUSEL", "DOCUMENT", "POLL", "CAROUSEL" ] }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "CREATED", "READY", "PLANNED", "PUBLISHED", "IN_REVIEW", "ACTIVATING", "MANUALLY_ACTIVATING", "ERROR", "DELETED", "CHECK_REVIEW_FEEDBACK", "IMPORTING" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "topics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "createdAt" : { "type" : "string" }, "updatedAt" : { "type" : "string" }, "publishAt" : { "type" : "string" }, "schedule" : { "type" : "string", "enum" : [ "PUBLISH_AS_SOON_AS_POSSIBLE", "PLANNED_POST_PUBLISH" ] }, "publishedAt" : { "type" : "string" }, "individualSchedulePerPlatform" : { "type" : "boolean" }, "individualPromotionPerPlatform" : { "type" : "boolean" }, "repeatPost" : { "type" : "boolean" }, "postRepetitionInterval" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "EVERY_TWO_WEEKS", "MONTHLY", "EVERY_TWO_MONTHS", "CUSTOM_DATES" ] }, "numberOfRepetitions" : { "type" : "integer", "format" : "int32" }, "repetitionDates" : { "type" : "array", "items" : { "type" : "string" } }, "processTaskAssigneeUserId" : { "type" : "string" }, "processTaskAssigneeUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "processReviewMessage" : { "type" : "string" }, "processReviewFeedback" : { "type" : "string" }, "processReviewFeedbackAnswer" : { "type" : "string" }, "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PostChannel" } }, "messagePerChannel" : { "type" : "boolean" }, "message" : { "type" : "string" }, "utmTracking" : { "$ref" : "#/components/schemas/UtmTracking" }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "videos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "document" : { "$ref" : "#/components/schemas/Document" }, "showLinkPreview" : { "type" : "boolean" }, "link" : { "type" : "string" }, "shortenLink" : { "type" : "boolean" }, "shortenedLink" : { "type" : "string" }, "linkTitle" : { "type" : "string" }, "linkDescription" : { "type" : "string" }, "linkCallToAction" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] }, "generatedLinkPreview" : { "$ref" : "#/components/schemas/GeneratedLinkPreview" }, "addLinkToBio" : { "type" : "boolean" }, "promotePost" : { "type" : "boolean" }, "selectedMetaPromotion" : { "$ref" : "#/components/schemas/SelectedItem" }, "selectedTikTokPromotion" : { "$ref" : "#/components/schemas/SelectedItem" }, "selectedDemandGenPromotion" : { "$ref" : "#/components/schemas/SelectedItem" }, "campaignReviewConfiguration" : { "$ref" : "#/components/schemas/CampaignReviewConfiguration" }, "selectedTargetingTemplateId" : { "type" : "string" }, "modifiedTarget" : { "$ref" : "#/components/schemas/Target" }, "targetName" : { "type" : "string" }, "targetInformation" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PostPromotionTargetInformation" } }, "adChannels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdChannel" } }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "totalBudget" : { "type" : "number", "format" : "double" }, "facebookBudget" : { "type" : "number", "format" : "double" }, "instagramBudget" : { "type" : "number", "format" : "double" }, "linkedInBudget" : { "type" : "number", "format" : "double" }, "twitterBudget" : { "type" : "number", "format" : "double" }, "tikTokBudget" : { "type" : "number", "format" : "double" }, "youTubeBudget" : { "type" : "number", "format" : "double" }, "currency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "promotionType" : { "type" : "string", "enum" : [ "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "CARS", "REAL_ESTATE", "JOBS", "EVENTS", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "DEMAND_GEN", "SMART" ] }, "campaignName" : { "type" : "string" }, "adName" : { "type" : "string" }, "createdFromAdTemplateId" : { "type" : "string" }, "createdFromPostTemplateId" : { "type" : "string" }, "postTemplateCategoryId" : { "type" : "string" }, "createdFromPostGenerationId" : { "type" : "string" }, "remark" : { "type" : "string" }, "postTargeting" : { "$ref" : "#/components/schemas/PostTargeting" }, "location" : { "$ref" : "#/components/schemas/Location" }, "activationErrorMessage" : { "type" : "string" }, "activationErrorChannel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "facebookBudgetOptimization" : { "type" : "string", "enum" : [ "CAMPAIGN_BUDGET_OPTIMIZATION", "ADSET_BUDGET_OPTIMIZATION" ] }, "facebookTrafficOptimization" : { "type" : "string", "enum" : [ "LINK_CLICKS", "LANDING_PAGE_VIEWS" ] }, "facebookInstagramAdMode" : { "type" : "string", "enum" : [ "SEPARATE_ADGROUPS", "SAME_ADGROUP" ] }, "linkedInBidType" : { "type" : "string", "enum" : [ "AUTOMATIC", "MANUAL" ] }, "linkedInBiddingOptimization" : { "type" : "string", "enum" : [ "MAXIMIZE_CLICKS", "MAXIMIZE_IMPRESSIONS", "MAXIMIZE_CONVERSIONS", "MAXIMIZE_LEADS" ] }, "linkedInCostType" : { "type" : "string", "enum" : [ "CPC", "CPM", "CPS" ] }, "linkedInMaxBid" : { "type" : "number", "format" : "double" }, "firstComment" : { "type" : "string" }, "promotionStartDate" : { "type" : "string" }, "promotionEndDate" : { "type" : "string" }, "importOrigin" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "sendNotificationOnPublication" : { "type" : "boolean" }, "externalPlatformDataSynchronizedAt" : { "type" : "string" }, "externalId" : { "type" : "string" }, "collaborationPost" : { "type" : "boolean" }, "pinterestBoard" : { "$ref" : "#/components/schemas/SelectedItem" }, "youTubePlaylist" : { "$ref" : "#/components/schemas/SelectedItem" }, "linkedInCampaignGroup" : { "$ref" : "#/components/schemas/CampaignGroup" }, "frequencyControl" : { "type" : "string", "enum" : [ "AUTOMATIC", "FREQUENCY_LIMIT", "MAX_FREQUENCY" ] }, "frequencyControlSpec" : { "$ref" : "#/components/schemas/FrequencyControlSpec" }, "frequencyControlLinkedIn" : { "type" : "string", "enum" : [ "AUTOMATIC", "FREQUENCY_LIMIT", "MAX_FREQUENCY" ] }, "frequencyControlLinkedInSpec" : { "$ref" : "#/components/schemas/FrequencyControlLinkedInSpec" }, "imagesTitle" : { "type" : "string" }, "advancedTikTokSettings" : { "$ref" : "#/components/schemas/AdvancedTikTokSettings" }, "advancedInstagramSettings" : { "$ref" : "#/components/schemas/AdvancedInstagramSettings" }, "advancedGmbSettings" : { "$ref" : "#/components/schemas/AdvancedGmbSettings" }, "beekeeperStream" : { "$ref" : "#/components/schemas/Stream" }, "beekeeperPostTitle" : { "type" : "string" }, "beekeeperPostLabels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BeekeeperPostLabel" } }, "textApprovalStatus" : { "type" : "string", "enum" : [ "NOT_STARTED", "READY_FOR_APPROVAL", "APPROVED", "CHECK_FEEDBACK" ] }, "contentApprovalStatus" : { "type" : "string", "enum" : [ "NOT_STARTED", "READY_FOR_APPROVAL", "APPROVED", "CHECK_FEEDBACK" ] }, "internalApprovalStatus" : { "type" : "string", "enum" : [ "NOT_STARTED", "READY_FOR_APPROVAL", "APPROVED", "CHECK_FEEDBACK" ] }, "createdFromTaskId" : { "type" : "string" }, "createdFromMcp" : { "type" : "boolean" } } }, "MetaBudgetSplit" : { "type" : "object", "properties" : { "facebookBudget" : { "type" : "number", "format" : "double" }, "instagramBudget" : { "type" : "number", "format" : "double" }, "storyBudget" : { "type" : "number", "format" : "double" }, "reelsBudget" : { "type" : "number", "format" : "double" } } }, "AdvancedGmbSettings" : { "type" : "object", "properties" : { "gmbFormat" : { "type" : "string", "enum" : [ "STANDARD", "EVENT" ] }, "eventTitle" : { "type" : "string" }, "eventStartDate" : { "type" : "string" }, "eventStartTime" : { "type" : "string" }, "eventEndDate" : { "type" : "string" }, "eventEndTime" : { "type" : "string" } } }, "Extension" : { "type" : "object", "properties" : { "sitelinkExtensions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SitelinkExtension" } }, "calloutExtensions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CalloutExtension" } }, "callExtensions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CallExtension" } } } }, "Collaborator" : { "type" : "object", "properties" : { "username" : { "type" : "string" } } }, "SalesForceUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "CampaignGroup" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "ARCHIVED", "CANCELED", "DRAFT", "PAUSED", "REMOVED" ] } } }, "BudgetChannel" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "selected" : { "type" : "boolean" }, "totalCost" : { "type" : "number", "format" : "double" }, "bid" : { "type" : "number", "format" : "double" }, "maxBid" : { "type" : "number", "format" : "double" }, "costType" : { "type" : "string", "enum" : [ "CPC", "CPM", "CPS" ] }, "bidType" : { "type" : "string", "enum" : [ "AUTOMATIC", "MANUAL" ] }, "linkedInBiddingOptimization" : { "type" : "string", "enum" : [ "MAXIMIZE_CLICKS", "MAXIMIZE_IMPRESSIONS", "MAXIMIZE_CONVERSIONS", "MAXIMIZE_LEADS" ] }, "linkedInDailyBudget" : { "type" : "number", "format" : "double" }, "facebookBudgetOptimization" : { "type" : "string", "enum" : [ "CAMPAIGN_BUDGET_OPTIMIZATION", "ADSET_BUDGET_OPTIMIZATION" ] }, "facebookTrafficOptimization" : { "type" : "string", "enum" : [ "LINK_CLICKS", "LANDING_PAGE_VIEWS" ] }, "twitterBudgetOptimization" : { "type" : "string", "enum" : [ "CAMPAIGN_BUDGET_OPTIMIZATION", "AD_GROUP_BUDGET_OPTIMIZATION" ] }, "tikTokBudgetOptimization" : { "type" : "string", "enum" : [ "CAMPAIGN_BUDGET_OPTIMIZATION", "AD_GROUP_BUDGET_OPTIMIZATION" ] }, "targetBudgets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetBudget" } } } }, "Location" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "CITY", "COUNTRY", "PAGE" ] } } }, "TargetRegion" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "CITY", "REGION", "ZIP", "COORDINATE" ] }, "city" : { "type" : "string" }, "useRadius" : { "type" : "boolean" }, "radiusInKm" : { "type" : "integer", "format" : "int32" }, "countryCode" : { "type" : "string" }, "lat" : { "type" : "number", "format" : "double" }, "lon" : { "type" : "number", "format" : "double" }, "bidModifier" : { "type" : "number", "format" : "double" }, "bidModifierType" : { "type" : "string", "enum" : [ "INCREASE", "DECREASE" ] }, "linkedInUrn" : { "type" : "string" }, "twitterTargetingValue" : { "type" : "string" }, "tikTokLocationId" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "externalPlaceId" : { "type" : "string" }, "regionReviewEnabled" : { "type" : "boolean" }, "regionReviewStatus" : { "type" : "string", "enum" : [ "PENDING_APPROVAL", "APPROVED", "NOT_APPROVED" ] }, "types" : { "type" : "array", "items" : { "type" : "string" } } } }, "CreateGoogleAdsAccountRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "currency" : { "type" : "string" }, "timezone" : { "type" : "string" }, "parentGoogleAdsAccountId" : { "type" : "string" } } }, "ProductTag" : { "type" : "object", "properties" : { "x" : { "type" : "number", "format" : "double" }, "y" : { "type" : "number", "format" : "double" }, "productId" : { "type" : "string" }, "productName" : { "type" : "string" } } }, "ActivatePostRequest" : { "type" : "object", "properties" : { "reviewMessage" : { "type" : "string" }, "publishImmediate" : { "type" : "boolean" } } }, "Image" : { "type" : "object", "properties" : { "thumbnailUrl" : { "type" : "string" }, "url" : { "type" : "string" }, "fileName" : { "type" : "string" }, "croppedUrl" : { "type" : "string" }, "croppedImageSize" : { "type" : "integer", "format" : "int64" }, "croppedWidth" : { "type" : "integer", "format" : "int32" }, "croppedHeight" : { "type" : "integer", "format" : "int32" }, "facebookImageUrl" : { "type" : "string" }, "tikTokImageId" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ImageTag" } }, "productTags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProductTag" } }, "link" : { "type" : "string" }, "linkTitle" : { "type" : "string" }, "linkDescription" : { "type" : "string" }, "order" : { "type" : "integer", "format" : "int32" }, "altText" : { "type" : "string" }, "mediaAssetId" : { "type" : "string" } } }, "Board" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "PageReadModel" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "username" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "PAGE", "PERSONAL_ACCOUNT", "CITY", "COUNTRY" ] }, "pictureUrl" : { "type" : "string" }, "accountId" : { "type" : "string" }, "externalImageId" : { "type" : "string" } } }, "ReachEstimateResult" : { "type" : "object", "properties" : { "users" : { "type" : "integer", "format" : "int64" }, "usersLowerBound" : { "type" : "integer", "format" : "int64" }, "usersUpperBound" : { "type" : "integer", "format" : "int64" } } }, "GoogleKeyword" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "competition" : { "type" : "string", "enum" : [ "LOW", "MEDIUM", "HIGH", "UNKNOWN" ] }, "averageMonghtlySearchVolume" : { "type" : "number", "format" : "double" }, "averageCpc" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "link" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "bid" : { "type" : "number", "format" : "double" }, "finalUrl" : { "type" : "string" }, "averageImpressionsPerMonth" : { "type" : "number", "format" : "double" } } }, "HubSpotUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "BlueskyUser" : { "type" : "object", "properties" : { "handle" : { "type" : "string" }, "appPassword" : { "type" : "string" } } }, "Subtenant" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE" ] }, "createdAt" : { "type" : "string" }, "googleUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "googleMyBusinessLocation" : { "$ref" : "#/components/schemas/GoogleMyBusinessLocation" }, "googleAnalyticsUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "facebookUser" : { "$ref" : "#/components/schemas/FacebookUser" }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "instagramAccount" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "facebookPageForInstagramAdvertising" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "hideFacebook" : { "type" : "boolean" }, "linkedInUser" : { "$ref" : "#/components/schemas/LinkedInUser" }, "linkedInPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "linkedInDefaultCampaignGroup" : { "$ref" : "#/components/schemas/CampaignGroup" }, "twitterUser" : { "$ref" : "#/components/schemas/TwitterUser" }, "twitterProfile" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "allowLongerXPosts" : { "type" : "boolean" }, "tikTokBusinessUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokProfileName" : { "type" : "string" }, "tikTokProfileImage" : { "$ref" : "#/components/schemas/Image" }, "tikTokIdentityId" : { "type" : "string" }, "youTubeUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "targetRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetRegion" } }, "language" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] }, "languages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "parentSubtenantId" : { "type" : "string" }, "statisticNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticNotification" } }, "color" : { "type" : "string" }, "website" : { "type" : "string" }, "variables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Variable" } }, "reportingBenchmarks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportingBenchmark" } }, "googleRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "skippablePostReview" : { "type" : "boolean" }, "postReviewUserId" : { "type" : "string" }, "postReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "campaignReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "postCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "secondPostReviewStepEnabled" : { "type" : "boolean" }, "secondCampaignReviewStepEnabled" : { "type" : "boolean" }, "secondPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "secondCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "thirdPostReviewStepEnabled" : { "type" : "boolean" }, "thirdCampaignReviewStepEnabled" : { "type" : "boolean" }, "thirdPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "thirdCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "enforceManualApprovalForSelfCreatedPosts" : { "type" : "boolean" }, "enforceManualApprovalForSelfCreatedCampaigns" : { "type" : "boolean" }, "allowInstagram" : { "type" : "boolean" }, "postTargeting" : { "$ref" : "#/components/schemas/PostTargeting" }, "responsibleUserId" : { "type" : "string" }, "linkedInAccountCurrency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "marginPercentage" : { "type" : "number", "format" : "double" }, "marginPerChannel" : { "type" : "boolean" }, "googleMarginPercentage" : { "type" : "number", "format" : "double" }, "facebookMarginPercentage" : { "type" : "number", "format" : "double" }, "linkedInMarginPercentage" : { "type" : "number", "format" : "double" }, "twitterMarginPercentage" : { "type" : "number", "format" : "double" }, "tikTokMarginPercentage" : { "type" : "number", "format" : "double" }, "primary" : { "type" : "boolean" }, "advertisingEnabled" : { "type" : "boolean" }, "postPublishingEnabled" : { "type" : "boolean" }, "suspendPostPublishing" : { "type" : "boolean" }, "postGenerationEnabled" : { "type" : "boolean" }, "automaticPostImportEnabled" : { "type" : "boolean" }, "automaticCampaignImportEnabled" : { "type" : "boolean" }, "campaignGenerationEnabled" : { "type" : "boolean" }, "postTargetingEnabled" : { "type" : "boolean" }, "needsSelectedTopicForPosts" : { "type" : "boolean" }, "hideFirstComment" : { "type" : "boolean" }, "hideManualPublishingOptions" : { "type" : "boolean" }, "hideTags" : { "type" : "boolean" }, "hideRemark" : { "type" : "boolean" }, "hideExtendedPostPromotionSettings" : { "type" : "boolean" }, "fixedNumberOfDaysForPostBoosting" : { "type" : "integer", "format" : "int32" }, "fixedBoostingBudget" : { "type" : "integer", "format" : "int32" }, "boostingCampaignNamePlaceholder" : { "type" : "string" }, "boostingAdNamePlaceholder" : { "type" : "string" }, "adCommentModerationEnabled" : { "type" : "boolean" }, "postCommentModerationEnabled" : { "type" : "boolean" }, "mentionModerationEnabled" : { "type" : "boolean" }, "messageModerationEnabled" : { "type" : "boolean" }, "reviewModerationEnabled" : { "type" : "boolean" }, "adCommentNotificationEnabled" : { "type" : "boolean" }, "postCommentNotificationEnabled" : { "type" : "boolean" }, "adCommentDefaultAssigneeUserId" : { "type" : "string" }, "postCommentDefaultAssigneeUserId" : { "type" : "string" }, "adCommentDefaultAssigneeTeamId" : { "type" : "string" }, "postCommentDefaultAssigneeTeamId" : { "type" : "string" }, "mentionNotificationEnabled" : { "type" : "boolean" }, "messageNotificationEnabled" : { "type" : "boolean" }, "reviewNotificationEnabled" : { "type" : "boolean" }, "hashtagNotificationEnabled" : { "type" : "boolean" }, "adCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "postCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "mentionNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "messageNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "reviewNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "hashtagNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "ccModerationNotificationUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "ccModerationNotificationScopes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "AD_COMMENTS", "POST_COMMENTS", "MENTIONS", "DIRECT_MESSAGES", "REVIEWS" ] } }, "netiquettePolicyEnabled" : { "type" : "boolean" }, "netiquettePolicy" : { "$ref" : "#/components/schemas/NetiquettePolicy" }, "businessHours" : { "$ref" : "#/components/schemas/BrandBusinessHours" }, "postPublishErrorHandling" : { "type" : "string", "enum" : [ "USER_NOTIFICATION", "SUPPORT_TICKET" ] }, "linkedInFollowerBreakdownByCountry" : { "type" : "boolean" }, "facebookFollowerBreakdownByCountry" : { "type" : "boolean" }, "adBeneficiary" : { "type" : "string" }, "adPayor" : { "type" : "string" }, "facebookCustomLinkParams" : { "type" : "string" }, "instagramCustomLinkParams" : { "type" : "string" }, "linkedInCustomLinkParams" : { "type" : "string" }, "tikTokCustomLinkParams" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "hashtagMonitoring" : { "$ref" : "#/components/schemas/HashtagMonitoring" }, "keywordMonitoring" : { "$ref" : "#/components/schemas/KeywordMonitoring" }, "profileMonitoring" : { "$ref" : "#/components/schemas/ProfileMonitoring" }, "newsMonitoring" : { "$ref" : "#/components/schemas/NewsMonitoring" }, "allowAddingLinksToBio" : { "type" : "boolean" }, "sendNotificationOnPostPublicationDefault" : { "type" : "boolean" }, "threadsUser" : { "$ref" : "#/components/schemas/ThreadsUser" }, "whatsAppUser" : { "$ref" : "#/components/schemas/WhatsAppUser" }, "blueskyUser" : { "$ref" : "#/components/schemas/BlueskyUser" }, "brevoUser" : { "$ref" : "#/components/schemas/BrevoUser" }, "sistrixUser" : { "$ref" : "#/components/schemas/SistrixUser" }, "pinterestUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "pinterestAdUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "canvaUser" : { "$ref" : "#/components/schemas/CanvaUser" }, "canvaFolderId" : { "type" : "string" }, "hubSpotUser" : { "$ref" : "#/components/schemas/HubSpotUser" }, "salesForceUser" : { "$ref" : "#/components/schemas/SalesForceUser" }, "beekeeperUser" : { "$ref" : "#/components/schemas/BeekeeperUser" }, "teadsUser" : { "$ref" : "#/components/schemas/TeadsUser" }, "mastodonUser" : { "$ref" : "#/components/schemas/MastodonUser" }, "snapchatUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "snapchatAdUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "pixxioUser" : { "$ref" : "#/components/schemas/PixxioUser" }, "cantoUser" : { "$ref" : "#/components/schemas/CantoUser" }, "biolinkPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "adDeliverySchedule" : { "type" : "string", "enum" : [ "DEFAULT", "ALL_DAY" ] }, "skipManualApprovalForPostWithoutPromotion" : { "type" : "boolean" }, "country" : { "type" : "string", "enum" : [ "CH", "DE", "AT", "US" ] }, "listeningNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ListeningNotification" } }, "subtenantCategoryId" : { "type" : "string" }, "allowShareableApprovalLink" : { "type" : "boolean" }, "xcustomLinkParams" : { "type" : "string" } } }, "ChannelStatistic" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "id" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "promotionId" : { "type" : "string" }, "cost" : { "type" : "number", "format" : "double" }, "currency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int32" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "cpa" : { "type" : "number", "format" : "double" }, "cpl" : { "type" : "number", "format" : "double" }, "clicksPerDay" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerDay" } }, "likes" : { "type" : "integer", "format" : "int32" }, "postClicks" : { "type" : "integer", "format" : "int32" }, "postReactions" : { "type" : "integer", "format" : "int32" }, "postEngagements" : { "type" : "integer", "format" : "int32" }, "comments" : { "type" : "integer", "format" : "int32" }, "linkClicks" : { "type" : "integer", "format" : "int32" }, "costPerLinkClick" : { "type" : "number", "format" : "double" }, "linkClickCtr" : { "type" : "number", "format" : "double" }, "landingPageViews" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "retweets" : { "type" : "integer", "format" : "int32" }, "reach" : { "type" : "integer", "format" : "int32" }, "totalReach" : { "type" : "integer", "format" : "int32" }, "nbrOfSessions" : { "type" : "integer", "format" : "int32" }, "averageSessionDuration" : { "type" : "integer", "format" : "int32" }, "bounceRate" : { "type" : "number", "format" : "double" }, "users" : { "type" : "integer", "format" : "int32" }, "newUsers" : { "type" : "integer", "format" : "int32" }, "pageViewsPerSession" : { "type" : "number", "format" : "double" }, "engagedSessions" : { "type" : "integer", "format" : "int32" }, "engagementRate" : { "type" : "number", "format" : "double" }, "screenPageViews" : { "type" : "integer", "format" : "int32" }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "videoViews" : { "type" : "integer", "format" : "int32" }, "video25PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video50PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video75PercentCompletions" : { "type" : "integer", "format" : "int32" }, "videoCompletions" : { "type" : "integer", "format" : "int32" }, "thumbstopRate" : { "type" : "number", "format" : "double" }, "videoCompletionRate" : { "type" : "number", "format" : "double" }, "thruplays" : { "type" : "integer", "format" : "int32" }, "videoWatched6s" : { "type" : "integer", "format" : "int32" }, "engagedView15s" : { "type" : "integer", "format" : "int32" }, "costPerThruplay" : { "type" : "number", "format" : "double" }, "messageSends" : { "type" : "integer", "format" : "int32" }, "messageOpens" : { "type" : "integer", "format" : "int32" }, "messageOpenRate" : { "type" : "number", "format" : "double" }, "audiencePenetration" : { "type" : "number", "format" : "double" }, "reactions" : { "type" : "integer", "format" : "int64" }, "calls" : { "type" : "integer", "format" : "int32" }, "likeClicks" : { "type" : "integer", "format" : "int32", "writeOnly" : true } } }, "MastodonUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "BlacklistWord" : { "type" : "object", "properties" : { "text" : { "type" : "string" } } }, "DayHours" : { "type" : "object", "properties" : { "openTime" : { "type" : "string" }, "closeTime" : { "type" : "string" } } }, "InfluencerCost" : { "type" : "object", "properties" : { "amount" : { "type" : "number", "format" : "double" }, "note" : { "type" : "string" } } }, "PostReadModel" : { "type" : "object", "properties" : { "externalId" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "PERSONAL_POST", "PAGE_POST", "STORY", "REELS", "SHORTS", "LINK_CAROUSEL", "DOCUMENT", "POLL", "CAROUSEL" ] }, "message" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "publishedAt" : { "type" : "string" }, "story" : { "type" : "string" }, "picture" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "videoUrl" : { "type" : "string" }, "videoTitle" : { "type" : "string" }, "accountId" : { "type" : "string" }, "page" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "tenantId" : { "type" : "string" }, "mediaType" : { "type" : "string" }, "externalImageId" : { "type" : "string" }, "externalVideoId" : { "type" : "string" }, "externalImageIds" : { "type" : "array", "items" : { "type" : "string" } }, "poll" : { "$ref" : "#/components/schemas/Poll" }, "link" : { "type" : "string" }, "linkTitle" : { "type" : "string" }, "linkDescription" : { "type" : "string" }, "mediaUrls" : { "type" : "array", "items" : { "type" : "string" } }, "collaborationPost" : { "type" : "boolean" }, "totalLikeCount" : { "type" : "integer", "format" : "int32" }, "totalCommentsCount" : { "type" : "integer", "format" : "int32" }, "repostsCount" : { "type" : "integer", "format" : "int32" }, "savedCount" : { "type" : "integer", "format" : "int32" }, "sharesCount" : { "type" : "integer", "format" : "int32" }, "totalViewsCount" : { "type" : "integer", "format" : "int32" } } }, "VideoTag" : { "type" : "object", "properties" : { "name" : { "type" : "string" } } }, "AdTarget" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "Promotion" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "CARS", "REAL_ESTATE", "JOBS", "EVENTS", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "DEMAND_GEN", "SMART" ] }, "customGoal" : { "type" : "string" }, "creationDate" : { "type" : "string", "format" : "date-time" }, "template" : { "$ref" : "#/components/schemas/Template" }, "status" : { "type" : "string", "enum" : [ "CREATED", "READY", "PLANNED", "BLOCKED", "IN_PROGRESS", "COMPLETED", "DELETED", "STOPPED", "ERROR", "ACTIVATING", "IMPORTING", "READY_FOR_PAYMENT", "IN_REVIEW", "LOCKED", "PRODUCT_SYNCHRONIZING", "CHECK_REVIEW_FEEDBACK" ] }, "statusBeforeActivation" : { "type" : "string", "enum" : [ "CREATED", "READY", "PLANNED", "BLOCKED", "IN_PROGRESS", "COMPLETED", "DELETED", "STOPPED", "ERROR", "ACTIVATING", "IMPORTING", "READY_FOR_PAYMENT", "IN_REVIEW", "LOCKED", "PRODUCT_SYNCHRONIZING", "CHECK_REVIEW_FEEDBACK" ] }, "importOrigin" : { "type" : "string", "enum" : [ "GOOGLE_ADWORDS", "FACEBOOK", "LINKED_IN", "TWITTER", "TIKTOK", "PINTEREST" ] }, "source" : { "type" : "string", "enum" : [ "TARGETING_TOOL", "TEMPLATE", "LEAD_CHATBOT", "GENERATION" ] }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" }, "assigneeUserId" : { "type" : "string" }, "assigneeUserEmail" : { "type" : "string" }, "title" : { "type" : "string" }, "namingTemplateElementValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NamingTemplateElementValue" } }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "topics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "channelConfigurations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChannelConfiguration" } }, "targets" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Target" } }, "budget" : { "$ref" : "#/components/schemas/Budget" }, "timeRange" : { "$ref" : "#/components/schemas/TimeRange" }, "currency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "version" : { "type" : "integer", "format" : "int32" }, "entityVersion" : { "type" : "integer", "format" : "int64" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "marginPercentage" : { "type" : "number", "format" : "double" }, "processReviewMessage" : { "type" : "string" }, "processReviewFeedback" : { "type" : "string" }, "processReviewFeedbackAnswer" : { "type" : "string" }, "processTaskAssigneeUserId" : { "type" : "string" }, "processTaskAssigneeUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "regionReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "createdFromCampaignGenerationId" : { "type" : "string" }, "createdFromPostId" : { "type" : "string" }, "activationStatus" : { "type" : "string", "enum" : [ "PENDING", "ERROR", "COMPLETED" ] }, "activationErrorMessage" : { "type" : "string" }, "activationErrorChannel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "color" : { "type" : "string" }, "pausedAt" : { "type" : "string" }, "externalPlatformDataSynchronizedAt" : { "type" : "string" }, "tenantTermsAccepted" : { "type" : "boolean" }, "createdFromTaskId" : { "type" : "string" }, "transferUpdatesToAdAccounts" : { "type" : "boolean" } } }, "GoogleMyBusinessLocation" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "locationName" : { "type" : "string" }, "title" : { "type" : "string" }, "placeId" : { "type" : "string" } } }, "ListeningNotification" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "types" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "COMMENT", "MENTION", "MONITORED_PROFILE_POST", "REVIEW", "HASHTAG", "KEYWORD", "NEWS" ] } }, "intention" : { "type" : "string", "enum" : [ "POSITIVE", "NEGATIVE", "NEUTRAL", "ALL" ] }, "keywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NewsKeyword" } }, "recipients" : { "type" : "array", "items" : { "type" : "string" } } } }, "NewsMonitoring" : { "type" : "object", "properties" : { "queries" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoredNews" } } } }, "Target" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "namingTemplateElementValues" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NamingTemplateElementValue" } }, "gender" : { "type" : "string", "enum" : [ "ALL", "MALE", "FEMALE" ] }, "language" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] }, "additionalLanguages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "linkedInTargetingEntityLinkOperator" : { "type" : "string", "enum" : [ "AND", "OR" ] }, "linkedInTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } }, "linkedInTargetingCriteriaGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingCriteriaGroup" } }, "googleAdGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GoogleAdGroup" } }, "twitterTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TwitterTargetingCriteria" } }, "tikTokTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TikTokTargetingCriteria" } }, "pinterestTargetingCriterias" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PinterestTargetingCriteria" } }, "pinterestPerformancePlusEnabled" : { "type" : "boolean" }, "pinterestPerformancePlusMinimumAge" : { "type" : "integer", "format" : "int32" }, "facebookInterestGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterestGroup" } }, "facebookInterests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterest" } }, "facebookAdGroups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookAdGroup" } }, "targetRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetRegion" } }, "targetRegionBehaviour" : { "$ref" : "#/components/schemas/TargetRegionBehaviour" }, "age" : { "$ref" : "#/components/schemas/Age" }, "yearsOfExperience" : { "$ref" : "#/components/schemas/YearsOfExperience" }, "devices" : { "$ref" : "#/components/schemas/Devices" }, "targetExclusion" : { "$ref" : "#/components/schemas/TargetExclusion" }, "retargeting" : { "$ref" : "#/components/schemas/Retargeting" }, "shoppingSettings" : { "$ref" : "#/components/schemas/ShoppingSettings" }, "dynamicSearchSettings" : { "$ref" : "#/components/schemas/DynamicSearchSettings" }, "extension" : { "$ref" : "#/components/schemas/Extension" }, "status" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "createdFromTargetingTemplateId" : { "type" : "string" }, "facebookSpecialAdCategory" : { "type" : "string", "enum" : [ "CREDIT", "EMPLOYMENT", "HOUSING", "ISSUES_ELECTIONS_POLITICS", "ONLINE_GAMBLING_AND_GAMING", "NONE" ] }, "facebookSpecialAdCategoryCountry" : { "type" : "string" }, "politicalIntent" : { "type" : "string", "enum" : [ "NOT_POLITICAL", "POLITICAL" ] }, "frequencyControl" : { "type" : "string", "enum" : [ "AUTOMATIC", "FREQUENCY_LIMIT", "MAX_FREQUENCY" ] }, "frequencyControlSpec" : { "$ref" : "#/components/schemas/FrequencyControlSpec" }, "frequencyControlLinkedIn" : { "type" : "string", "enum" : [ "AUTOMATIC", "FREQUENCY_LIMIT", "MAX_FREQUENCY" ] }, "frequencyControlLinkedInSpec" : { "$ref" : "#/components/schemas/FrequencyControlLinkedInSpec" }, "enableAdvantagePlusTargeting" : { "type" : "boolean" } } }, "TemplateCategory" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "userId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "nameEN" : { "type" : "string" }, "nameFR" : { "type" : "string" }, "nameES" : { "type" : "string" }, "nameIT" : { "type" : "string" } } }, "ProductScope" : { "type" : "object", "properties" : { "productDimension" : { "type" : "string", "enum" : [ "BRAND", "PRODUCT_NR", "STATE", "PRODUCT_TYPE", "CUSTOM_LABEL_0", "CUSTOM_LABEL_1", "CUSTOM_LABEL_2", "CUSTOM_LABEL_3", "CUSTOM_LABEL_4", "CHANNEL", "CHANNEL_EXCLUSIVE" ] }, "value" : { "type" : "string" } } }, "WhatsAppUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "accountId" : { "type" : "string" }, "phoneNumberId" : { "type" : "string" } } }, "SelectedMusic" : { "type" : "object", "properties" : { "platform" : { "type" : "string", "enum" : [ "INSTAGRAM", "TIKTOK" ] }, "id" : { "type" : "string" }, "title" : { "type" : "string" }, "artist" : { "type" : "string" }, "duration" : { "type" : "integer", "format" : "int32" }, "coverUrl" : { "type" : "string" }, "previewUrl" : { "type" : "string" } } }, "PinterestUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "FacebookInstantExperienceThumbnail" : { "type" : "object", "properties" : { "elementId" : { "type" : "string" }, "photoId" : { "type" : "string" }, "height" : { "type" : "integer", "format" : "int32" }, "width" : { "type" : "integer", "format" : "int32" }, "cropTopLeft" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } }, "cropBottomRight" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "SelectedItem" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "BrandBusinessHours" : { "type" : "object", "properties" : { "timezone" : { "type" : "string" }, "days" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DayBusinessHours" } } } }, "SnapchatUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "organizationId" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "Keyword" : { "type" : "object", "properties" : { "value" : { "type" : "string" }, "matchType" : { "type" : "string", "enum" : [ "BROAD", "PHRASE", "EXACT" ] } } }, "SubtenantReadModel" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "INACTIVE" ] }, "createdAt" : { "type" : "string" }, "googleUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "googleAnalyticsUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "googleMyBusinessLocation" : { "$ref" : "#/components/schemas/GoogleMyBusinessLocation" }, "facebookUser" : { "$ref" : "#/components/schemas/FacebookUser" }, "linkedInUser" : { "$ref" : "#/components/schemas/LinkedInUser" }, "linkedInPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "linkedInDefaultCampaignGroup" : { "$ref" : "#/components/schemas/CampaignGroup" }, "twitterUser" : { "$ref" : "#/components/schemas/TwitterUser" }, "facebookPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "instagramAccount" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "hideFacebook" : { "type" : "boolean" }, "twitterProfile" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "allowLongerXPosts" : { "type" : "boolean" }, "tikTokBusinessUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "tikTokProfileName" : { "type" : "string" }, "tikTokProfileImage" : { "$ref" : "#/components/schemas/Image" }, "youTubeUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "targetRegions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TargetRegion" } }, "parentSubtenantId" : { "type" : "string" }, "statisticNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticNotification" } }, "color" : { "type" : "string" }, "linkedInAccountCurrency" : { "type" : "string", "enum" : [ "CHF", "USD", "EUR", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CAD", "CDF", "CHE", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "UYI", "UYU", "UYW", "UZS", "VES", "VND", "VUV", "WST", "XAF", "XCD", "XOF", "XPF", "XSU", "YER", "ZAR", "ZMW", "ZWL" ] }, "authorizationGroup" : { "$ref" : "#/components/schemas/Group" }, "language" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] }, "languages" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "ALL", "DE", "FR", "EN", "IT", "ES", "PT", "NL", "SV", "RO", "CS", "EL", "TR", "PL", "DA", "EU", "CY", "CA", "HU", "SK", "SL", "SQ", "HY", "BS", "BG", "HR", "UK", "NO", "FI" ] } }, "website" : { "type" : "string" }, "variables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Variable" } }, "reportingBenchmarks" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportingBenchmark" } }, "googleRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterRetargetingLists2" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "googleExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "facebookExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "linkedInExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "twitterExcludedRetargetingLists" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RetargetingList" } }, "skippablePostReview" : { "type" : "boolean" }, "postReviewUserId" : { "type" : "string" }, "postReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "campaignReviewUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "secondPostReviewStepEnabled" : { "type" : "boolean" }, "secondCampaignReviewStepEnabled" : { "type" : "boolean" }, "secondPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "secondCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewSecondStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "thirdPostReviewStepEnabled" : { "type" : "boolean" }, "thirdCampaignReviewStepEnabled" : { "type" : "boolean" }, "thirdPostReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "thirdCampaignReviewStepUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "postCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "campaignCandidateReviewThirdStepMode" : { "type" : "string", "enum" : [ "ONE_CANDIDATE_APPROVAL", "ALL_CANDIDATES_APPROVAL" ] }, "enforceManualApprovalForSelfCreatedPosts" : { "type" : "boolean" }, "skipManualApprovalForPostWithoutPromotion" : { "type" : "boolean" }, "allowInstagram" : { "type" : "boolean" }, "postTargeting" : { "$ref" : "#/components/schemas/PostTargeting" }, "responsibleUserId" : { "type" : "string" }, "marginPercentage" : { "type" : "number", "format" : "double" }, "marginPerChannel" : { "type" : "boolean" }, "googleMarginPercentage" : { "type" : "number", "format" : "double" }, "facebookMarginPercentage" : { "type" : "number", "format" : "double" }, "linkedInMarginPercentage" : { "type" : "number", "format" : "double" }, "twitterMarginPercentage" : { "type" : "number", "format" : "double" }, "tikTokMarginPercentage" : { "type" : "number", "format" : "double" }, "primary" : { "type" : "boolean" }, "advertisingEnabled" : { "type" : "boolean" }, "postPublishingEnabled" : { "type" : "boolean" }, "postGenerationEnabled" : { "type" : "boolean" }, "campaignGenerationEnabled" : { "type" : "boolean" }, "automaticPostImportEnabled" : { "type" : "boolean" }, "automaticCampaignImportEnabled" : { "type" : "boolean" }, "postTargetingEnabled" : { "type" : "boolean" }, "needsSelectedTopicForPosts" : { "type" : "boolean" }, "hideFirstComment" : { "type" : "boolean" }, "hideManualPublishingOptions" : { "type" : "boolean" }, "hideTags" : { "type" : "boolean" }, "hideRemark" : { "type" : "boolean" }, "hideExtendedPostPromotionSettings" : { "type" : "boolean" }, "suspendPostPublishing" : { "type" : "boolean" }, "fixedNumberOfDaysForPostBoosting" : { "type" : "integer", "format" : "int32" }, "fixedBoostingBudget" : { "type" : "integer", "format" : "int32" }, "boostingCampaignNamePlaceholder" : { "type" : "string" }, "boostingAdNamePlaceholder" : { "type" : "string" }, "adCommentModerationEnabled" : { "type" : "boolean" }, "postCommentModerationEnabled" : { "type" : "boolean" }, "adCommentDefaultAssigneeUserId" : { "type" : "string" }, "postCommentDefaultAssigneeUserId" : { "type" : "string" }, "adCommentDefaultAssigneeTeamId" : { "type" : "string" }, "postCommentDefaultAssigneeTeamId" : { "type" : "string" }, "mentionModerationEnabled" : { "type" : "boolean" }, "messageModerationEnabled" : { "type" : "boolean" }, "reviewModerationEnabled" : { "type" : "boolean" }, "adCommentNotificationEnabled" : { "type" : "boolean" }, "postCommentNotificationEnabled" : { "type" : "boolean" }, "mentionNotificationEnabled" : { "type" : "boolean" }, "messageNotificationEnabled" : { "type" : "boolean" }, "reviewNotificationEnabled" : { "type" : "boolean" }, "hashtagNotificationEnabled" : { "type" : "boolean" }, "linkedInFollowerBreakdownByCountry" : { "type" : "boolean" }, "facebookFollowerBreakdownByCountry" : { "type" : "boolean" }, "adBeneficiary" : { "type" : "string" }, "adPayor" : { "type" : "string" }, "facebookCustomLinkParams" : { "type" : "string" }, "instagramCustomLinkParams" : { "type" : "string" }, "linkedInCustomLinkParams" : { "type" : "string" }, "tikTokCustomLinkParams" : { "type" : "string" }, "favorite" : { "type" : "boolean" }, "ccModerationNotificationUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "ccModerationNotificationScopes" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "AD_COMMENTS", "POST_COMMENTS", "MENTIONS", "DIRECT_MESSAGES", "REVIEWS" ] } }, "netiquettePolicyEnabled" : { "type" : "boolean" }, "netiquettePolicy" : { "$ref" : "#/components/schemas/NetiquettePolicy" }, "businessHours" : { "$ref" : "#/components/schemas/BrandBusinessHours" }, "hashtagMonitoring" : { "$ref" : "#/components/schemas/HashtagMonitoring" }, "keywordMonitoring" : { "$ref" : "#/components/schemas/KeywordMonitoring" }, "profileMonitoring" : { "$ref" : "#/components/schemas/ProfileMonitoring" }, "newsMonitoring" : { "$ref" : "#/components/schemas/NewsMonitoring" }, "allowAddingLinksToBio" : { "type" : "boolean" }, "sendNotificationOnPostPublicationDefault" : { "type" : "boolean" }, "biolinkPage" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "threadsUser" : { "$ref" : "#/components/schemas/ThreadsUser" }, "whatsAppUser" : { "$ref" : "#/components/schemas/WhatsAppUser" }, "blueskyUser" : { "$ref" : "#/components/schemas/BlueskyUser" }, "pinterestUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "pinterestAdUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "canvaUser" : { "$ref" : "#/components/schemas/CanvaUser" }, "canvaFolderId" : { "type" : "string" }, "hubSpotUser" : { "$ref" : "#/components/schemas/HubSpotUser" }, "salesForceUser" : { "$ref" : "#/components/schemas/SalesForceUser" }, "brevoUser" : { "$ref" : "#/components/schemas/BrevoUser" }, "sistrixUser" : { "$ref" : "#/components/schemas/SistrixUser" }, "beekeeperUser" : { "$ref" : "#/components/schemas/BeekeeperUser" }, "teadsUser" : { "$ref" : "#/components/schemas/TeadsUser" }, "mastodonUser" : { "$ref" : "#/components/schemas/MastodonUser" }, "snapchatUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "snapchatAdUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "pixxioUser" : { "$ref" : "#/components/schemas/PixxioUser" }, "cantoUser" : { "$ref" : "#/components/schemas/CantoUser" }, "adCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "postCommentNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "mentionNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "messageNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "reviewNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "hashtagNotificationMode" : { "type" : "string", "enum" : [ "ALL", "URGENT_PRIORITY_ONLY", "URGENT_OR_HIGH_PRIORITY_ONLY", "URGENT_OR_HIGH_OR_MEDIUM_PRIORITY_ONLY" ] }, "listeningNotifications" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ListeningNotification" } }, "subtenantCategoryId" : { "type" : "string" }, "allowShareableApprovalLink" : { "type" : "boolean" }, "xcustomLinkParams" : { "type" : "string" } } }, "InfluencerProfile" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "socialHandle" : { "type" : "string" }, "followers" : { "type" : "integer", "format" : "int64" }, "statsUpdatedAt" : { "type" : "string" }, "statsManual" : { "type" : "boolean" } } }, "KeywordMonitoring" : { "type" : "object", "properties" : { "keywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoredKeyword" } } } }, "LinkedInUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "expires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "refreshToken" : { "type" : "string" }, "refreshTokenExpires" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "CANCELED", "DRAFT", "REMOVED" ] } } }, "YearsOfExperience" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "value" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "NamingTemplateElementValue" : { "type" : "object", "properties" : { "elementId" : { "type" : "string" }, "value" : { "type" : "string" } } }, "PostChannel" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "page" : { "$ref" : "#/components/schemas/ThirdPartyPage" }, "selected" : { "type" : "boolean" }, "accountId" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "PERSONAL_POST", "PAGE_POST", "STORY", "REELS", "SHORTS", "LINK_CAROUSEL", "DOCUMENT", "POLL", "CAROUSEL" ] }, "shareToFeed" : { "type" : "boolean" }, "collaborators" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Collaborator" } }, "poll" : { "$ref" : "#/components/schemas/Poll" }, "message" : { "type" : "string" }, "mentions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Mention" } }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "videos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "document" : { "$ref" : "#/components/schemas/Document" }, "showLinkPreview" : { "type" : "boolean" }, "link" : { "type" : "string" }, "shortenLink" : { "type" : "boolean" }, "shortenedLink" : { "type" : "string" }, "linkTitle" : { "type" : "string" }, "linkDescription" : { "type" : "string" }, "linkCallToAction" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] }, "generatedLinkPreview" : { "$ref" : "#/components/schemas/GeneratedLinkPreview" }, "addLinkToBio" : { "type" : "boolean" }, "utmTracking" : { "$ref" : "#/components/schemas/UtmTracking" }, "publishManually" : { "type" : "boolean" }, "firstComment" : { "type" : "string" }, "customLinkParams" : { "type" : "string" }, "publishAt" : { "type" : "string" }, "promotionStartDate" : { "type" : "string" }, "promotionEndDate" : { "type" : "string" }, "imagesTitle" : { "type" : "string" }, "selectedMusic" : { "$ref" : "#/components/schemas/SelectedMusic" }, "longHeadline" : { "type" : "string" } } }, "ThreadsUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "username" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" } } }, "Tag" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "userId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "text" : { "type" : "string" }, "color" : { "type" : "string" }, "mode" : { "type" : "string", "enum" : [ "MEDIA_LIBRARY", "POST_TEMPLATE", "MODERATION" ] }, "textFR" : { "type" : "string" }, "textEN" : { "type" : "string" }, "textIT" : { "type" : "string" }, "textES" : { "type" : "string" }, "templateCategory" : { "$ref" : "#/components/schemas/TemplateCategory" } } }, "ThirdPartyPreviewResponse" : { "type" : "object", "properties" : { "previewUrl" : { "type" : "string" }, "previewHtml" : { "type" : "string" } } }, "CustomEvent" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" }, "assigneeUserId" : { "type" : "string" }, "assigneeUserEmail" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "EMAIL_CAMPAIGN", "PRINT_CAMPAIGN", "PRESS_RELEASE", "INTERNAL_COMMUNICATION", "OTHER", "EVENT", "ONLINE_PLATFORM", "ADVERTISING", "BLOG" ] }, "status" : { "type" : "string", "enum" : [ "CREATED", "DELETED" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "topics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "start" : { "type" : "string" }, "end" : { "type" : "string" }, "processReviewFeedback" : { "type" : "string" }, "processReviewFeedbackAnswer" : { "type" : "string" }, "title" : { "type" : "string" }, "description" : { "type" : "string" }, "externalId" : { "type" : "string" }, "allDay" : { "type" : "boolean" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileAttachment" } }, "color" : { "type" : "string" }, "sendNotification" : { "type" : "boolean" }, "notificationTiming" : { "type" : "string", "enum" : [ "EVENT_START", "ONE_HOUR_BEFORE_START", "TWENTY_FOUR_HOURS_BEFORE_START", "TWO_DAYS_BEFORE_START" ] }, "notificationUsers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "sentNotificationAt" : { "type" : "string" }, "links" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Link" } }, "createdFromTaskId" : { "type" : "string" }, "recurring" : { "type" : "boolean" }, "duration" : { "type" : "string" }, "rrule" : { "type" : "string" }, "seriesId" : { "type" : "string" }, "recurrenceFrequency" : { "type" : "string", "enum" : [ "WEEKLY", "BIWEEKLY", "MONTHLY", "BIMONTHLY", "MONTHLY_NTH_WEEKDAY", "ANNUALLY" ] } } }, "CarouselSlideStatistic" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "clicks" : { "type" : "integer", "format" : "int32" } } }, "PinterestAdAccount" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "currency" : { "type" : "string" } } }, "Task" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "topicId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "TODO", "IN_PROGRESS", "IN_REVIEW", "DONE" ] }, "boardColumnId" : { "type" : "string" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "userAssigneeId" : { "type" : "string" }, "dueDate" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileAttachment" } }, "shortCode" : { "type" : "integer", "format" : "int32" }, "order" : { "type" : "integer", "format" : "int32" } } }, "NewsLanguage" : { "type" : "object", "properties" : { "language" : { "type" : "string" }, "code" : { "type" : "string" } } }, "SitelinkExtension" : { "type" : "object", "properties" : { "feedId" : { "type" : "integer", "format" : "int64" }, "feedItemId" : { "type" : "integer", "format" : "int64" }, "assetId" : { "type" : "integer", "format" : "int64" }, "adwordsCustomerId" : { "type" : "string" }, "extensionStatus" : { "type" : "string", "enum" : [ "ACCOUNT", "CAMPAIGN", "ADGROUP", "NONE" ] }, "extensionRunStatus" : { "type" : "string", "enum" : [ "ADDED_CAMPAIGN", "ADDED_ADGROUP", "ADDED_ACCOUNT", "IS_CAMPAIGN_LINKED", "IS_ADGROUP_LINKED", "UNLINKING", "UNLINKED" ] }, "sitelinkName" : { "type" : "string" }, "sitelinkUrl" : { "type" : "string" }, "sitelinkDescription1" : { "type" : "string" }, "sitelinkDescription2" : { "type" : "string" }, "finalUrls" : { "type" : "array", "items" : { "type" : "string" } }, "finalMobileUrls" : { "type" : "array", "items" : { "type" : "string" } }, "sitelinkTrackingUrl" : { "type" : "string" } } }, "PromotionHeader" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "title" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "CARS", "REAL_ESTATE", "JOBS", "EVENTS", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "DEMAND_GEN", "SMART" ] }, "status" : { "type" : "string", "enum" : [ "CREATED", "READY", "PLANNED", "BLOCKED", "IN_PROGRESS", "COMPLETED", "DELETED", "STOPPED", "ERROR", "ACTIVATING", "IMPORTING", "READY_FOR_PAYMENT", "IN_REVIEW", "LOCKED", "PRODUCT_SYNCHRONIZING", "CHECK_REVIEW_FEEDBACK" ] }, "color" : { "type" : "string" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "createdByUserEmail" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "totalCost" : { "type" : "number", "format" : "double" }, "start" : { "type" : "string", "format" : "date-time" }, "end" : { "type" : "string", "format" : "date-time" }, "nbrOfDays" : { "type" : "integer", "format" : "int32" }, "durationType" : { "type" : "string", "enum" : [ "SHORT_TERM", "LONG_TERM" ] }, "version" : { "type" : "integer", "format" : "int32" }, "impressions" : { "type" : "integer", "format" : "int64" }, "clicks" : { "type" : "integer", "format" : "int64" }, "cost" : { "type" : "number", "format" : "double" }, "netCost" : { "type" : "number", "format" : "double" }, "conversions" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "ctr" : { "type" : "number", "format" : "double" }, "cpc" : { "type" : "number", "format" : "double" }, "cpm" : { "type" : "number", "format" : "double" }, "reactions" : { "type" : "integer", "format" : "int64" }, "importOrigin" : { "type" : "string", "enum" : [ "GOOGLE_ADWORDS", "FACEBOOK", "LINKED_IN", "TWITTER", "TIKTOK", "PINTEREST" ] }, "mode" : { "type" : "string", "enum" : [ "SIMPLE", "EXTENDED", "EXPERT" ] }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "source" : { "type" : "string", "enum" : [ "TARGETING_TOOL", "TEMPLATE", "LEAD_CHATBOT", "GENERATION" ] }, "processReviewFeedback" : { "type" : "string" }, "activationErrorMessage" : { "type" : "string" }, "activationErrorChannel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "activationStatus" : { "type" : "string", "enum" : [ "PENDING", "ERROR", "COMPLETED" ] }, "processTaskAssigneeUserId" : { "type" : "string" }, "processTaskAssigneeUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "channelConfigurations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ChannelConfiguration" } } } }, "GoogleMerchantAccount" : { "type" : "object", "properties" : { "merchantAccountId" : { "type" : "string" }, "name" : { "type" : "string" } } }, "UtmTracking" : { "type" : "object", "properties" : { "utmSource" : { "type" : "string" }, "utmMedium" : { "type" : "string" }, "utmCampaign" : { "type" : "string" }, "utmTerm" : { "type" : "string" }, "utmContent" : { "type" : "string" }, "customParams" : { "type" : "string" } } }, "HashtagMonitoring" : { "type" : "object", "properties" : { "hashtags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MonitoredHashtag" } } } }, "CarouselSlide" : { "type" : "object", "properties" : { "descriptions" : { "type" : "array", "items" : { "type" : "string" } }, "links" : { "type" : "array", "items" : { "type" : "string" } }, "titles" : { "type" : "array", "items" : { "type" : "string" } }, "images" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Image" } }, "videos" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Video" } }, "callToActions" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] } }, "displayLinks" : { "type" : "array", "items" : { "type" : "string" } }, "utmTracking" : { "$ref" : "#/components/schemas/UtmTracking" } } }, "DayBusinessHours" : { "type" : "object", "properties" : { "dayOfWeek" : { "type" : "string", "enum" : [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "active" : { "type" : "boolean" }, "startTime" : { "type" : "string" }, "endTime" : { "type" : "string" } } }, "Template" : { "type" : "object", "properties" : { "imageAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "textAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "videoAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "collectionAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "carouselAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "documentAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "shoppingAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "spotlightAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "messageAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "eventAds" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Ad" } }, "trackingUrlTemplate" : { "type" : "string" }, "customParameters" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomParameter" } }, "finalUrlSuffix" : { "type" : "string" }, "url" : { "type" : "string" }, "createdFromAdTemplateId" : { "type" : "string" }, "facebookLeadForm" : { "$ref" : "#/components/schemas/LeadForm" }, "linkedInLeadForm" : { "$ref" : "#/components/schemas/LeadForm" }, "automaticPostPromotion" : { "$ref" : "#/components/schemas/AutomaticPostPromotion" }, "automaticPostPromotions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AutomaticPostPromotion" } } } }, "InterestBrand" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "level" : { "type" : "string" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/InterestBrand" } } } }, "UpdateLocationStatusRequest" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "OPEN", "CLOSED_TEMPORARILY", "CLOSED_PERMANENTLY" ] } } }, "ListingChannel" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "selected" : { "type" : "boolean" } } }, "UpdateAdStatusRequest" : { "type" : "object", "properties" : { "adId" : { "type" : "string" }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "adVariation" : { "$ref" : "#/components/schemas/AdVariation" }, "adStatus" : { "type" : "string", "enum" : [ "IS_RUNNING", "STOP", "IN_REVIEW", "REMOVED", "COMPLETED", "DISAPPROVED", "IS_STOPPING" ] }, "targetId" : { "type" : "string" }, "promotionId" : { "type" : "string" } } }, "Stream" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "default" : { "type" : "boolean" } } }, "TestMessageAdRequest" : { "type" : "object", "properties" : { "promotionId" : { "type" : "string" }, "adId" : { "type" : "string" } } }, "CustomParameter" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "value" : { "type" : "string" } } }, "BeekeeperUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "AdGroupAutomationSettings" : { "type" : "object", "properties" : { "adGroupId" : { "type" : "string" }, "assetGroupId" : { "type" : "string" }, "keywordAutomationSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KeywordAutomationSettings" } }, "internalId" : { "type" : "string" }, "adGroupName" : { "type" : "string" } } }, "UploadVideoResult" : { "type" : "object", "properties" : { "videoId" : { "type" : "string" }, "thumbnailId" : { "type" : "string" } } }, "FacebookProductSet" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "nbrOfProducts" : { "type" : "integer", "format" : "int32" } } }, "PromotionSettingsRequest" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Tag" } }, "topics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "color" : { "type" : "string" }, "subtenant" : { "$ref" : "#/components/schemas/Subtenant" }, "type" : { "type" : "string", "enum" : [ "TRAFFIC", "CONVERSIONS", "RETARGETING", "SHOPPING", "CARS", "REAL_ESTATE", "JOBS", "EVENTS", "APP", "ENGAGEMENT", "VIDEO_VIEWS", "CALLS", "REACH", "FOLLOWERS", "PROFILE_VIEWS", "LEADS", "PERFORMANCE_MAX", "DEMAND_GEN", "SMART" ] }, "customGoal" : { "type" : "string" }, "marginPercentage" : { "type" : "number", "format" : "double" } } }, "RetargetingList" : { "type" : "object", "properties" : { "googleCustomerId" : { "type" : "string" }, "facebookAccountId" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "OPEN", "NOT_ENOUGH_USERS", "CLOSED" ] }, "userId" : { "type" : "string" }, "googleRetargetingListId" : { "type" : "string" }, "facebookCustomAudienceId" : { "type" : "string" }, "linkedInAudienceId" : { "type" : "string" }, "twitterAudienceId" : { "type" : "string" }, "tikTokAudienceId" : { "type" : "string" }, "pinterestAudienceId" : { "type" : "string" }, "urlPath" : { "type" : "string" }, "engagementSource" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "engagementType" : { "type" : "string", "enum" : [ "ENGAGED", "FOLLOWER" ] }, "description" : { "type" : "string" }, "audienceSize" : { "type" : "integer", "format" : "int64" }, "retentionDays" : { "type" : "integer", "format" : "int64" } } }, "ChannelConfiguration" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "selected" : { "type" : "boolean" }, "googleUser" : { "$ref" : "#/components/schemas/GoogleUser" }, "facebookUser" : { "$ref" : "#/components/schemas/FacebookUser" }, "linkedInUser" : { "$ref" : "#/components/schemas/LinkedInUser" }, "twitterUser" : { "$ref" : "#/components/schemas/TwitterUser" }, "tikTokUser" : { "$ref" : "#/components/schemas/TikTokUser" }, "pinterestUser" : { "$ref" : "#/components/schemas/PinterestUser" }, "mastodonUser" : { "$ref" : "#/components/schemas/MastodonUser" }, "snapchatUser" : { "$ref" : "#/components/schemas/SnapchatUser" }, "campaignGroup" : { "$ref" : "#/components/schemas/CampaignGroup" }, "activationStatus" : { "type" : "string", "enum" : [ "PENDING", "ERROR", "COMPLETED" ] }, "activationErrorMessage" : { "type" : "string" } } }, "TikTokUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "expires" : { "type" : "string" }, "refreshToken" : { "type" : "string" }, "refreshTokenExpires" : { "type" : "string" }, "accessTokenSecret" : { "type" : "string" }, "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "displayName" : { "type" : "string" }, "profileImageUrl" : { "type" : "string" }, "profileImageId" : { "type" : "string" } } }, "PinterestTargetingCriteria" : { "type" : "object", "properties" : { "pinterestInterests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelectedItem" } }, "pinterestKeywords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Keyword" } } } }, "SocialMessageBlacklist" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "name" : { "type" : "string" }, "blacklistWords" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BlacklistWord" } }, "sendNotification" : { "type" : "boolean" }, "hideComments" : { "type" : "boolean" }, "deleteComments" : { "type" : "boolean" }, "notificationUserIds" : { "type" : "array", "items" : { "type" : "string" } }, "channels" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } } }, "AdvancedInstagramSettings" : { "type" : "object", "properties" : { "aiGenerated" : { "type" : "boolean" }, "trialGraduationStrategy" : { "type" : "string" } } }, "TargetRegionBehaviour" : { "type" : "object", "properties" : { "interestedInThatRegion" : { "type" : "boolean" }, "locatedInThatRegion" : { "type" : "boolean" } } }, "NetiquettePolicy" : { "type" : "object", "properties" : { "url" : { "type" : "string" }, "text" : { "type" : "string" } } }, "UpdatePromotionBudgetAndBiddingRequest" : { "type" : "object", "properties" : { "budgetChannels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BudgetChannel" } } } }, "LinkedInTargetingEntity" : { "type" : "object", "properties" : { "facetUrn" : { "type" : "string" }, "urn" : { "type" : "string" }, "name" : { "type" : "string" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LinkedInTargetingEntity" } }, "parentUrn" : { "type" : "string" } } }, "FacebookInterest" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "name" : { "type" : "string" }, "audience_size" : { "type" : "integer", "format" : "int64" }, "children" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterest" } }, "path" : { "type" : "array", "items" : { "type" : "string" } } } }, "Variable" : { "type" : "object", "properties" : { "key" : { "type" : "string" }, "value" : { "type" : "string" } } }, "ClosedRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "ConversionTracker" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "googleCustomerId" : { "type" : "string" }, "facebookAccountId" : { "type" : "string" }, "facebookCustomConversionId" : { "type" : "string" }, "facebookCustomConversionEventName" : { "type" : "string" }, "facebookStandardEventName" : { "type" : "string" }, "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "INACTIVE", "ACTIVE" ] }, "snippet" : { "type" : "string" }, "revenueValue" : { "type" : "number", "format" : "double" }, "userId" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "currency" : { "type" : "string" }, "pixelSnippet" : { "type" : "string" }, "googleTrackerId" : { "type" : "string" }, "googleGlobalSiteTag" : { "type" : "string" }, "twitterWebEventTag" : { "type" : "string" }, "linkedInConversionId" : { "type" : "string" }, "googleConversionId" : { "type" : "string" }, "googleConversionLabel" : { "type" : "string" }, "tikTokAccountId" : { "type" : "string" }, "tikTokPixelId" : { "type" : "string" }, "tikTokEventName" : { "type" : "string" } } }, "PixxioUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "CantoUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string", "writeOnly" : true }, "expires" : { "type" : "string" }, "accountId" : { "type" : "string" }, "refreshToken" : { "type" : "string", "writeOnly" : true }, "refreshTokenExpires" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "instanceUrl" : { "type" : "string" }, "accountKey" : { "type" : "string", "writeOnly" : true }, "server" : { "type" : "string" }, "appId" : { "type" : "string" }, "appSecret" : { "type" : "string" }, "uniqueIdentifier" : { "type" : "string" } } }, "PostPromotionTargetInformation" : { "type" : "object", "properties" : { "selectedTargetingTemplateId" : { "type" : "string" }, "modifiedTarget" : { "$ref" : "#/components/schemas/Target" }, "targetName" : { "type" : "string" }, "channels" : { "type" : "array", "items" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] } } } }, "NewsCountry" : { "type" : "object", "properties" : { "country" : { "type" : "string" }, "url" : { "type" : "string" } } }, "FacebookUser" : { "type" : "object", "properties" : { "internalId" : { "type" : "string" }, "name" : { "type" : "string" }, "accessToken" : { "type" : "string" }, "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "accountType" : { "type" : "string", "enum" : [ "AD_ACCOUNT", "USER_ACCOUNT" ] }, "currency" : { "type" : "string" }, "metaReAuthReminderCount" : { "type" : "integer", "format" : "int32" }, "metaReAuthReminderLastSentAt" : { "type" : "string", "format" : "date-time" } } }, "StatisticPerDay" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "impressions" : { "type" : "integer", "format" : "int64" }, "organicImpressions" : { "type" : "integer", "format" : "int32" }, "clicks" : { "type" : "integer", "format" : "int32" }, "cost" : { "type" : "number", "format" : "double" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "averagePosition" : { "type" : "number", "format" : "double" }, "followers" : { "type" : "integer", "format" : "int32" }, "facebookFollowers" : { "type" : "integer", "format" : "int32" }, "facebookPageLikes" : { "type" : "integer", "format" : "int32" }, "instagramFollowers" : { "type" : "integer", "format" : "int32" }, "linkedInFollowers" : { "type" : "integer", "format" : "int32" }, "twitterFollowers" : { "type" : "integer", "format" : "int32" }, "youTubeFollowers" : { "type" : "integer", "format" : "int32" }, "followersGained" : { "type" : "integer", "format" : "int32" }, "followersLost" : { "type" : "integer", "format" : "int32" }, "tikTokFollowers" : { "type" : "integer", "format" : "int32" }, "blueskyFollowers" : { "type" : "integer", "format" : "int32" }, "threadsFollowers" : { "type" : "integer", "format" : "int32" }, "pinterestFollowers" : { "type" : "integer", "format" : "int32" }, "mastodonFollowers" : { "type" : "integer", "format" : "int32" }, "snapchatFollowers" : { "type" : "integer", "format" : "int32" }, "retweets" : { "type" : "integer", "format" : "int32" }, "likes" : { "type" : "integer", "format" : "int32" }, "follows" : { "type" : "integer", "format" : "int32" }, "reach" : { "type" : "integer", "format" : "int32" }, "calls" : { "type" : "integer", "format" : "int32" }, "postClicks" : { "type" : "integer", "format" : "int32" }, "postReactions" : { "type" : "integer", "format" : "int32" }, "postEngagements" : { "type" : "integer", "format" : "int32" }, "comments" : { "type" : "integer", "format" : "int32" }, "linkClicks" : { "type" : "integer", "format" : "int32" }, "landingPageViews" : { "type" : "integer", "format" : "int32" }, "videoViews" : { "type" : "integer", "format" : "int32" }, "video25PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video50PercentCompletions" : { "type" : "integer", "format" : "int32" }, "video75PercentCompletions" : { "type" : "integer", "format" : "int32" }, "videoCompletions" : { "type" : "integer", "format" : "int32" }, "thruplays" : { "type" : "integer", "format" : "int32" }, "videoWatched6s" : { "type" : "integer", "format" : "int32" }, "engagedView15s" : { "type" : "integer", "format" : "int32" }, "costPerThruplay" : { "type" : "number", "format" : "double" }, "messageSends" : { "type" : "integer", "format" : "int32" }, "messageOpens" : { "type" : "integer", "format" : "int32" }, "messageOpenRate" : { "type" : "number", "format" : "double" }, "nbrOfSessions" : { "type" : "integer", "format" : "int32" }, "averageSessionDuration" : { "type" : "integer", "format" : "int32" }, "bounceRate" : { "type" : "number", "format" : "double" }, "users" : { "type" : "integer", "format" : "int32" }, "newUsers" : { "type" : "integer", "format" : "int32" }, "pageViewsPerSession" : { "type" : "number", "format" : "double" }, "engagedSessions" : { "type" : "integer", "format" : "int32" }, "screenPageViews" : { "type" : "integer", "format" : "int32" }, "deviceStatistics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FlatDailyChannelDataPerDevice" } }, "channelStatistics" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatisticPerChannel" } }, "absoluteTopImpressionPercentage" : { "type" : "number", "format" : "double" }, "topImpressionPercentage" : { "type" : "number", "format" : "double" }, "paidImpressions" : { "type" : "integer", "format" : "int32" }, "organicReach" : { "type" : "integer", "format" : "int32" }, "paidReach" : { "type" : "integer", "format" : "int32" }, "organicVideoViews" : { "type" : "integer", "format" : "int32" }, "paidVideoViews" : { "type" : "integer", "format" : "int32" }, "results" : { "type" : "number", "format" : "double" }, "costPerResult" : { "type" : "number", "format" : "double" }, "estimatedMinutesWatched" : { "type" : "integer", "format" : "int32" }, "pageViews" : { "type" : "integer", "format" : "int32" }, "reactions" : { "type" : "integer", "format" : "int64" } } }, "PromotionTikTokAudience" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" } } }, "AdChannel" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "placement" : { "type" : "string", "enum" : [ "GOOGLE_SEARCH_NETWORK", "FACEBOOK_TIMELINE", "GOOGLE_DISPLAY_NETWORK", "FACEBOOK_AUDIENCE_NETWORK", "YOUTUBE", "INSTAGRAM_TIMELINE", "GOOGLE_SHOPPING", "FACEBOOK_MESSENGER", "LINKEDIN_CONTENT", "LINKEDIN_TEXT", "LINKEDIN_INMAIL", "LINKEDIN_DYNAMIC", "FACEBOOK_STORIES", "FACEBOOK_INSTANT_ARTICLES", "FACEBOOK_RIGHT_HAND_COLUMN", "FACEBOOK_MARKETPLACE", "INSTAGRAM_STORIES", "FACEBOOK_MESSENGER_STORIES", "FACEBOOK_SEARCH", "FACEBOOK_INSTREAM_VIDEO", "FACEBOOK_REELS", "INSTAGRAM_EXPLORE_HOME", "INSTAGRAM_PROFILE_FEED", "INSTAGRAM_PROFILE_REELS", "LINKEDIN_AUDIENCE_NETWORK", "TWITTER_ALL", "TWITTER_PUBLISHER_NETWORK", "TWITTER_SEARCH", "TWITTER_TIMELINE", "TWITTER_PROFILE", "GOOGLE_MY_BUSINESS", "FACEBOOK_UNKNOWN", "FACEBOOK_VIDEO_FEED", "INSTAGRAM_REELS", "INSTAGRAM_SHOP", "INSTAGRAM_EXPLORE", "TIKTOK_FEED", "META_AUTOMATIC", "THREADS_FEED", "BLUESKY_FEED", "PINTEREST_FEED" ] }, "selected" : { "type" : "boolean" } } }, "Topic" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "tenantId" : { "type" : "string" }, "subtenantId" : { "type" : "string" }, "parentTopicId" : { "type" : "string" }, "name" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "DRAFT", "PLANNED", "IN_PROGRESS", "COMPLETED" ] }, "description" : { "type" : "string" }, "start" : { "type" : "string" }, "end" : { "type" : "string" }, "color" : { "type" : "string" }, "parentAnnualPlanTopicId" : { "type" : "string" }, "createdAt" : { "type" : "string" }, "createdByUserId" : { "type" : "string" }, "createdByUserEmail" : { "type" : "string" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FileAttachment" } }, "userAssigneeId" : { "type" : "string" }, "userAssigneeFullname" : { "type" : "string" }, "category" : { "type" : "string" }, "templateCategory" : { "$ref" : "#/components/schemas/SelectedItem" } } }, "FrequencyControlSpec" : { "type" : "object", "properties" : { "intervalInDays" : { "type" : "integer", "format" : "int32" }, "maxFrequency" : { "type" : "integer", "format" : "int32" } } }, "ModifiedAdRequest" : { "type" : "object", "properties" : { "adStatisticId" : { "type" : "string" }, "modifiedAd" : { "$ref" : "#/components/schemas/AdVariation" } } }, "FacebookInterestGroup" : { "type" : "object", "properties" : { "facebookInterests" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FacebookInterest" } } } }, "ConversionTracking" : { "type" : "object", "properties" : { "facebookConversionTracker" : { "$ref" : "#/components/schemas/ConversionTracker" }, "googleConversionTracker" : { "$ref" : "#/components/schemas/ConversionTracker" }, "linkedInConversionTracker" : { "$ref" : "#/components/schemas/ConversionTracker" }, "linkedInConversionTrackers" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConversionTracker" } }, "twitterConversionTracker" : { "$ref" : "#/components/schemas/ConversionTracker" }, "tikTokConversionTracker" : { "$ref" : "#/components/schemas/ConversionTracker" } } }, "CarouselSlideVariation" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "link" : { "type" : "string" }, "title" : { "type" : "string" }, "image" : { "$ref" : "#/components/schemas/Image" }, "video" : { "$ref" : "#/components/schemas/Video" }, "callToAction" : { "type" : "string", "enum" : [ "APPLY_NOW", "BOOK_NOW", "CONTACT_US", "DOWNLOAD", "MORE_OF_THIS", "SHOP_NOW", "ORDER_NOW", "REGISTER", "WATCH_MORE", "NO_BUTTON", "CALL_NOW", "SUBSCRIBE", "GET_QUOTE", "GET_OFFER", "LEARN_MORE", "SIGN_UP", "JOIN", "ATTEND", "REQUEST_DEMO", "LISTEN_NOW", "GET_SHOWTIMES", "UNLOCK_FULL_DOCUMENT", "BUY_NOW", "VISIT_SITE", "REGISTER_NOW", "FIND_A_DEALER", "ADD_TO_CART", "WATCH_NOW", "READ_MORE", "BUY_TICKETS", "DONATE_NOW", "EXPLORE_MORE", "FIND_A_LOCATION", "FIND_RETAILERS", "GET_DEAL", "GET_RECIPE", "ON_SALE", "PLAY_GAME", "TRY_IT" ] }, "utmTracking" : { "$ref" : "#/components/schemas/UtmTracking" } } }, "PromotionAutomationSettings" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "promotionId" : { "type" : "string" }, "budgetChannelAutomationSettings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BudgetChannelAutomationSettings" } }, "lastBudgetOptimizationRun" : { "type" : "string", "format" : "date-time" }, "lastOptimizationRun" : { "type" : "string", "format" : "date-time" } } }, "StatisticPerChannel" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "FACEBOOK", "INSTAGRAM", "GOOGLE_ADWORDS", "GOOGLE_DISPLAY_NETWORK", "GOOGLE_ANALYTICS", "YOUTUBE", "XING", "LINKED_IN", "TWITTER", "GOOGLE_MY_BUSINESS", "TIKTOK", "BITLY", "THREADS", "BLUESKY", "WHATSAPP", "PINTEREST", "CANVA", "HUBSPOT", "SALESFORCE", "BREVO", "SISTRIX", "NEWS", "BEEKEEPER", "TEADS", "MASTODON", "SNAPCHAT", "PIXXIO", "YEXT", "CANTO" ] }, "clicks" : { "type" : "integer", "format" : "int64" }, "cost" : { "type" : "number", "format" : "double" }, "impressions" : { "type" : "integer", "format" : "int64" }, "conversions" : { "type" : "number", "format" : "double" }, "leads" : { "type" : "number", "format" : "double" }, "conversionValue" : { "type" : "number", "format" : "double" }, "allConversions" : { "type" : "number", "format" : "double" }, "accountId" : { "type" : "string" }, "nbrOfSessions" : { "type" : "integer", "format" : "int32" }, "engagedSessions" : { "type" : "integer", "format" : "int32" }, "users" : { "type" : "integer", "format" : "int32" }, "newUsers" : { "type" : "integer", "format" : "int32" } } }, "PinData" : { "type" : "object", "properties" : { "link" : { "type" : "string" }, "title" : { "type" : "string" }, "description" : { "type" : "string" }, "media_source_image_url" : { "type" : "string" }, "media_source_video_id" : { "type" : "string" } } }, "ChangeHoursRequest" : { "type" : "object", "properties" : { "channels" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ListingChannel" } }, "type" : { "type" : "string", "enum" : [ "REGULAR", "SPECIAL", "CLOSED" ] }, "regularHours" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/DayHours" } }, "specialHours" : { "$ref" : "#/components/schemas/SpecialHours" }, "closedRange" : { "$ref" : "#/components/schemas/ClosedRange" } } }, "AdPreviewRequest" : { "type" : "object", "properties" : { "creative_type" : { "type" : "string" }, "image_url" : { "type" : "string" }, "promotion_id" : { "type" : "string" }, "title" : { "type" : "string" }, "pin_data" : { "$ref" : "#/components/schemas/PinData" } } }, "Poll" : { "type" : "object", "properties" : { "question" : { "type" : "string" }, "settings" : { "$ref" : "#/components/schemas/PollSettings" }, "options" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PollOption" } }, "uniqueVotersCount" : { "type" : "integer", "format" : "int64" } } }, "PromotionLinkedInMatchedAudience" : { "type" : "object", "properties" : { "retargetingList" : { "$ref" : "#/components/schemas/RetargetingList" } } }, "UploadImageResult" : { "type" : "object", "properties" : { "imageUrl" : { "type" : "string" }, "imageId" : { "type" : "string" } } } } } }