{ "swagger": "2.0", "info": { "version": "1.0.0", "description": "Identify your most influential customers and activate them to drive more conversions on social.", "title": "MAVRCK.IO" }, "paths": { "/anonymous-incentive-claim": { "post": { "tags": [ "AnonymousIncentiveClaim" ], "operationId": "claimIncentiveForAnonymousUser", "x-handler": "anonymous_incentive_claim/anonymous_incentive_claim_controller.js", "x-access": [ "anonymous", "influencer" ], "summary": "Claim an incentive anonymously", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "fingerprint", "referralProgramId" ], "properties": { "fingerprint": { "type": "string" }, "referralProgramId": { "type": "number" } } } } ], "responses": { "200": { "description": "Claimed code", "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dynamicPromoCode": { "type": "string" } } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/influencers/{membershipId}/points-history": { "get": { "tags": [ "Points" ], "operationId": "getInfluencerPointsHistory", "x-handler": "points/influencer_points_history_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve the points history for an influencer.", "parameters": [ { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "name": "membershipId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "Collection of point transactions.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/PointTransaction" }, "type": "array" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "Points" ], "operationId": "grantPointToInfluencer", "x-handler": "points/influencer_points_history_controller.js", "x-access": [ "administrator" ], "summary": "Grant points for an influencer in a manual entry.", "parameters": [ { "name": "data", "in": "body", "schema": { "type": "object", "required": [ "amount", "reason" ], "properties": { "amount": { "type": "integer" }, "reason": { "type": "string" } } } }, { "name": "membershipId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Point Grant URI", "schema": { "$ref": "#/definitions/PointGrantURI" } }, "400": { "description": "Point grant not completed.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Point grant already completed for this influencer.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Point grant not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action/{actionId}/activation": { "post": { "tags": [ "Activations" ], "x-handler": "activations/action_activation_controller.js", "x-access": [ "influencer" ], "summary": "Create an activation when an action is completed by a user.", "parameters": [ { "name": "data", "in": "body", "schema": { "type": "object" } }, { "name": "actionId", "in": "path", "required": true, "type": "string" }, { "name": "productExperience", "in": "query", "required": false, "type": "string", "description": "Tag this activation with a key denoting the experience/channel in which the user created the activation." }, { "name": "utmSource", "in": "query", "type": "string", "required": false }, { "name": "utmMedium", "in": "query", "type": "string", "required": false }, { "name": "utmTerm", "in": "query", "type": "string", "required": false }, { "name": "utmContent", "in": "query", "type": "string", "required": false }, { "name": "utmCampaign", "in": "query", "type": "string", "required": false }, { "name": "iovationIdentifier", "in": "query", "type": "string", "required": false } ], "responses": { "200": { "description": "Activation URIs", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/ActivationURI" } } } } }, "400": { "description": "Action not completed.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Action already completed by this influencer.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action/{actionId}/activations": { "get": { "tags": [ "Activations" ], "operationId": "getActionActivations", "x-handler": "activations/action_activation_controller.js", "x-access": [ "administrator", "root", "influencer" ], "summary": "Retrieve activations for an action.", "parameters": [ { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/approvalStatus" }, { "name": "actionId", "in": "path", "required": true, "type": "string" }, { "name": "minStars", "in": "query", "required": false, "type": "integer", "description": "Filter on minimum stars." }, { "name": "myActivations", "in": "query", "default": false, "type": "boolean", "description": "As an influencer, select only my activations associated with the action." } ], "responses": { "200": { "description": "Collection of activations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ActivationDeprecated" }, "type": "array" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/communities": { "get": { "tags": [ "Communities" ], "x-handler": "community/community_controller.js", "x-access": [ "administrator" ], "operationId": "getCommunities", "summary": "Query Mavrck communities available to the authenticated administrator.", "parameters": [ { "name": "omitCurrent", "in": "query", "required": false, "type": "boolean", "description": "Omit the community that the administrator is currently authenticated into." }, { "name": "name", "in": "query", "type": "string", "description": "Community name" }, { "name": "id", "in": "query", "type": "string", "description": "Community Id" }, { "name": "accountId", "in": "query", "type": "string", "description": "Administrator account id that can be used to filter the list down to only instances they have access to." }, { "name": "includeAll", "in": "query", "type": "string", "description": "Root only parameter for requesting all communities beyond normal access" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderByParam" } ], "responses": { "200": { "description": "An array of Mavrck communities.", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/Community" }, "type": "array" } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Communities not found.", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "Communities" ], "x-handler": "community/community_controller.js", "x-access": [ "root" ], "summary": "Creates a community.", "operationId": "createCommunity", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId", "features" ], "properties": { "communityId": { "type": "string" }, "name": { "type": "string" }, "features": { "type": "array", "items": { "$ref": "#/definitions/UpdateEntitlementFields" } } } } } ], "responses": { "200": { "description": "URI.", "schema": { "type": "object", "properties": { "id": { "type": "integer" } } } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Error, community failed to create", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/communities/{id}": { "get": { "tags": [ "Communities" ], "operationId": "getCommunity", "x-handler": "community/community_controller.js", "x-access": [ "root" ], "summary": "Retrieve a single community.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "A single community.", "schema": { "$ref": "#/definitions/Community" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Community not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/actions": { "post": { "tags": [ "Actions" ], "x-handler": "actions/action_controller.js", "x-access": [ "administrator" ], "summary": "Create an action.", "operationId": "createAction", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ActionDeprecated" } }, { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Action URI.", "schema": { "$ref": "#/definitions/ActionURI" } }, "400": { "description": "Invalid input.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/re-order-actions": { "put": { "tags": [ "ActionGroups" ], "x-handler": "actions/action_group_controller.js", "x-access": [ "administrator" ], "summary": "Create an action.", "operationId": "reOrderActions", "description": "Accepts an ordered list of action ids", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "actionIds": { "type": "array", "items": { "type": "string" } } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid input.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action/{id}": { "get": { "x-handler": "actions/action_controller.js", "x-access": [ "administrator", "root", "influencer" ], "summary": "Retrieve an individual action.", "operationId": "getActionById", "parameters": [ { "name": "id", "in": "path", "description": "ID of the action.", "required": true, "type": "string" } ], "responses": { "200": { "description": "An individual action", "schema": { "$ref": "#/definitions/ActionDeprecated" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Actions" ] }, "put": { "x-handler": "actions/action_controller.js", "x-access": [ "administrator" ], "summary": "Update an action.", "operationId": "update", "parameters": [ { "name": "id", "in": "path", "description": "ID of action", "required": true, "type": "string" }, { "name": "data", "in": "body", "schema": { "$ref": "#/definitions/ActionDeprecated" } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Actions" ] }, "delete": { "x-handler": "actions/action_controller.js", "x-access": [ "administrator" ], "operationId": "delete", "summary": "Delete an action.", "parameters": [ { "name": "id", "in": "path", "description": "ID of action", "required": true, "type": "string" } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Actions" ] } }, "/action/{id}/link": { "get": { "x-handler": "tracking_links/tracking_link_controller.js", "x-access": [ "influencer" ], "summary": "Retrieve a tracking link for an action.", "operationId": "getActionTrackingLink", "parameters": [ { "name": "id", "in": "path", "description": "ID of the action.", "required": true, "type": "string" }, { "name": "photo", "in": "query", "description": "A link to user's photo", "required": false, "type": "string" }, { "name": "referrer", "in": "query", "description": "Referrer", "required": false, "type": "string" }, { "name": "^utm_.+$", "in": "query", "required": false, "type": "string", "description": "Utm variables" } ], "responses": { "200": { "description": "A tracking link", "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "url": { "type": "string" }, "conversionCount": { "type": "integer" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Tracking Link" ] } }, "/action-groups/{id}": { "get": { "x-handler": "actions/action_group_controller.js", "x-access": [ "administrator", "anonymous", "root", "influencer", "shared-cipher" ], "summary": "Retrieve an individual action group.", "operationId": "getActionGroupById", "x-sharedCipherParameters": { "actionGroupId": "id" }, "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "hasActivated", "in": "query", "type": "boolean", "description": "Whether to return already activated actions in the action group." }, { "name": "simple", "in": "query", "type": "boolean", "description": "If true, then do not include associated data." } ], "responses": { "200": { "description": "An individual action group", "schema": { "$ref": "#/definitions/ActionGroupDeprecated" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "ActionGroups" ] }, "put": { "x-handler": "actions/action_group_controller.js", "x-access": [ "administrator", "root" ], "summary": "Update an action group.", "operationId": "updateActionGroup", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "$ref": "#/definitions/ActionGroupDeprecated" } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource non-existent", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "ActionGroups" ] }, "delete": { "x-handler": "actions/action_group_controller.js", "x-access": [ "administrator", "root" ], "tags": [ "ActionGroups" ], "summary": "Delete an action group.", "operationId": "destroyActionGroup", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Action group deleted successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/application": { "get": { "x-handler": "action_group_candidates/action_group_application_controller.js", "summary": "Retrieve an individual application.", "operationId": "getActionGroupApplication", "x-sharedCipherParameters": { "actionGroupId": "id" }, "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "communityId", "in": "query", "type": "string" } ], "responses": { "200": { "description": "Application for an activity", "schema": { "$ref": "#/definitions/Application" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Application" ] }, "put": { "x-handler": "action_group_candidates/action_group_application_controller.js", "x-access": [ "administrator" ], "summary": "Update an application for an action group.", "operationId": "updateActionGroupApplication", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "$ref": "#/definitions/Application" } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource non-existent", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Application" ] } }, "/action-groups/{id}/unarchive": { "post": { "x-handler": "actions/action_group_controller.js", "summary": "Unarchive/Restore an action group", "x-access": [ "administrator" ], "tags": [ "ActionGroups" ], "operationId": "unarchive", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Unarchival successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API key.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action Group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/candidates/{globalUserId}/assessment": { "post": { "x-handler": "action_group_candidates/action_group_candidate_assessment_controller.js", "x-access": [ "administrator", "shared-cipher" ], "tags": [ "Candidates" ], "summary": "Create an assessment for an influencer.", "operationId": "createAssessment", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "approves": { "type": "boolean" }, "assessorEmail": { "type": "string" }, "assessorName": { "type": "string" } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Either the action group or global user was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "x-handler": "action_group_candidates/action_group_candidate_assessment_controller.js", "x-access": [ "administrator", "shared-cipher" ], "tags": [ "Candidates" ], "summary": "Update an assessment for an influencer.", "operationId": "updateAssessment", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "approves": { "type": "boolean" }, "assessorEmail": { "type": "string" }, "assessorName": { "type": "string" } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Either the action group or global user was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "x-handler": "action_group_candidates/action_group_candidate_assessment_controller.js", "x-access": [ "administrator", "shared-cipher" ], "tags": [ "Candidates" ], "summary": "Delete an assessment for an influencer.", "operationId": "deleteAssessment", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "name": "assessorEmail", "in": "query", "description": "Email of the assessor whose assessment should be deleted. Scopes the deletion to the calling reviewer so concurrent reviewers' assessments are not affected.", "required": false, "type": "string" }, { "name": "assessorName", "in": "query", "description": "Name of the assessor whose assessment should be deleted.", "required": false, "type": "string" } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Either the action group or global user was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups": { "get": { "x-access": [ "administrator", "influencer", "mvk-s2s", "root" ], "x-handler": "actions/action_group_controller.js", "summary": "Retrieve all action groups.", "operationId": "getAllActionGroups", "responses": { "200": { "description": "An array of action groups", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ActionGroupDeprecated" }, "type": "array" }, "pagination": { "type": "object", "properties": { "next": { "type": "string" } } } } } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "parameters": [ { "name": "q", "in": "query", "type": "string", "description": "Search for action group title." }, { "description": "CSV of desired statuses (e.g. status=LIVE,PAUSED)", "name": "status", "in": "query", "items": { "type": "string" }, "type": "array", "collectionFormat": "csv" }, { "name": "sortable", "in": "query", "type": "boolean", "description": "Whether an action group is available to be sorted." }, { "name": "campaignId", "in": "query", "type": "integer", "description": "Campaign Id" }, { "name": "audienceId", "in": "query", "type": "integer", "description": "Audience Id" }, { "name": "communityId", "in": "query", "type": "string" }, { "name": "type", "in": "query", "type": "string", "enum": [ "create", "amplify", "survey", "review", "follow", "view", "other" ] }, { "name": "hasActivated", "in": "query", "type": "boolean", "description": "Whether to return already activated actions in the action group." }, { "name": "eligibleToAddInfluencers", "in": "query", "type": "boolean", "description": "Whether to return only action groups that have an application." }, { "name": "actionsNotIncluded", "in": "query", "type": "boolean", "description": "Whether to return action groups without actions included." }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/channel" }, { "$ref": "#/parameters/orderDirection" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "draftDueDate", "contentDueDate", "startDate", "endDate", "createdAt", "activatedUsersMetrics", "engagementsMetrics", "clicksMetrics", "impressionsMetrics", "conversionsCountMetrics", "conversionsValueMetrics" ] }, { "name": "includeExportData", "in": "query", "type": "boolean", "description": "Whether to return action groups with the incentives summary and all affiliate data included. Used for the export." }, { "name": "ids", "in": "query", "type": "array", "items": { "type": "integer" }, "description": "A comma-separated list of action group ids." }, { "name": "simple", "in": "query", "type": "boolean", "description": "If set to true, this will only return action group attributes. Only usable by administrators and other mvk services." }, { "name": "communityIds", "in": "query", "type": "array", "items": { "type": "string" } } ], "tags": [ "ActionGroups" ] }, "post": { "x-handler": "actions/action_group_controller.js", "x-access": [ "administrator" ], "summary": "Create an action group.", "operationId": "createActionGroup", "parameters": [ { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "campaignId": { "type": "integer" }, "audienceId": { "type": "integer" }, "startDate": { "format": "date-time", "type": "string", "description": "The scheduled time in which the action group will become available to influencers." }, "endDate": { "format": "date-time", "type": [ "string", "null" ], "description": "The scheduled time in which the action group will no longer be available to influencers." }, "image": { "type": "string", "description": "For non-custom action groups, this will set the image on its child actions." }, "type": { "type": "string", "default": "custom" }, "url": { "type": "string", "description": "If type is content, then this is provided to generate the child actions." }, "title": { "type": "string", "description": "When not auto-generated, this is provided as a title for the activity." }, "name": { "type": "string", "description": "When not auto-generated, this is provided as a name (self-service use) for the activity." }, "description": { "type": "string", "description": "When not auto-generated, this is provided as a description for the activity." }, "network": { "type": "string", "description": "An optional network that can be specified for an activity such as photo challenge." }, "multipleActivations": { "type": "boolean", "description": "Indicates whether this action group's performance action(s) can be completed multiple times. Only available for photoChallenge." }, "list": { "type": "boolean", "description": "Indicates whether this action group has a custom list." }, "ftcHashtag": { "type": "string", "description": "FTC hashtag for an action group (not required)." }, "requiredHashtag": { "type": "string", "description": "Required hashtag for an action group." }, "internalDescription": { "type": "string", "description": "Action group level description, internal to brand." }, "activityBudget": { "type": "number", "description": "Budget for all actions in action group." }, "numberOfInfluencers": { "type": "integer", "description": "Target number of influencers for all actions under an action group." }, "contentDueDate": { "type": [ "string", "null" ], "description": "Due date for content on an action group." }, "draftDueDate": { "type": [ "string", "null" ], "description": "Due date for drafts on an action group." }, "globalUserListId": { "type": "integer" } } } } ], "responses": { "200": { "description": "ActionGroup URI", "schema": { "$ref": "#/definitions/ActionGroupURI" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Either the campaign or audience was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "ActionGroups" ] } }, "/incentives/{incentiveId}/incentive-claims": { "get": { "x-handler": "incentive_claims/incentive_claim_controller.js", "tags": [ "Incentives" ], "x-access": [ "administrator", "root" ], "operationId": "getIncentiveClaims", "summary": "Fetch all of the claims for this incentive.", "parameters": [ { "name": "incentiveId", "in": "path", "required": true, "type": "integer" }, { "name": "excludeWinningClaims", "in": "query", "required": false, "type": "boolean", "description": "If the IncentiveClaim has an associated IncentiveWin, then it will not appear in the result set." }, { "name": "excludeWinningInfluencerClaims", "in": "query", "required": false, "type": "boolean", "description": "If an Influencer has an IncentiveWin, then none of their IncentiveClaims will appear in the result set." }, { "name": "uniqueInfluencers", "in": "query", "required": false, "type": "boolean", "description": "Only show one claim per influencer in the result set" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderByParam" } ], "responses": { "200": { "description": "An array of incentive claims.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/IncentiveClaimDeprecated" } } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API key or resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/incentives/{incentiveId}/winners": { "get": { "x-handler": "incentives/incentive_winners_controller.js", "tags": [ "Incentives" ], "x-access": [ "administrator", "root" ], "operationId": "getWinners", "summary": "Fetch the winners for this incentive.", "parameters": [ { "name": "incentiveId", "in": "path", "required": true, "type": "integer" }, { "name": "disqualified", "in": "query", "type": "boolean", "description": "Filter winners based on whether they have been disqualified from this incentive or not." } ], "responses": { "200": { "description": "An array of incentive winners.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/IncentiveWinner" }, "type": "array" } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key or resource forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource non-existent.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "x-handler": "incentives/incentive_winners_controller.js", "tags": [ "Incentives" ], "operationId": "selectWinnersRandom", "x-access": [ "administrator", "root" ], "summary": "If the incentive is of a type where there are fewer winners than claims, this will determine the winners.", "parameters": [ { "name": "incentiveId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": false, "schema": { "type": "object", "properties": { "selectionMethod": { "type": "string", "description": "Automatic or manual selection. Defaults to automatic if neither is specified." }, "incentiveClaimIds": { "type": "array", "items": { "type": "integer" } }, "excludeWinnersSince": { "type": [ "string", "boolean" ], "format": "date-time", "description": "Filter winners based on whether they have recently won before since a given date-time." } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "'VALIDATION_ERROR', either 'winners_already_selected', 'action_group_not_expired', or 'incentive_not_sweepstakes'.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key or resource forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource non-existent.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/incentives/{incentiveId}/winners/{id}/disqualification": { "put": { "x-handler": "incentives/incentive_winner_disqualification_controller.js", "tags": [ "Incentives" ], "operationId": "disqualifyUser", "x-access": [ "administrator", "root" ], "summary": "Disqualify an incentive winner.", "parameters": [ { "name": "incentiveId", "in": "path", "required": true, "type": "integer" }, { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": false, "schema": { "type": "object", "properties": { "disqualificationReason": { "type": "string", "description": "The reason why the influencer is being disqualified as an incentive winner." } } } } ], "responses": { "200": { "description": "Incentive winner successfully disqualified.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Incentive winner cannot be disqualified. Occurs if 'reward_already_fulfilled'.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "API Key invalid or access denied.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Incentive or winner not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/incentives/{incentiveId}/winners/{id}/requalification": { "put": { "x-handler": "incentives/incentive_winner_requalification_controller.js", "tags": [ "Incentives" ], "operationId": "requalifyUser", "x-access": [ "administrator", "root" ], "summary": "Requalify a disqualified incentive winner.", "parameters": [ { "name": "incentiveId", "in": "path", "required": true, "type": "integer" }, { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Incentive winner successfully requalified.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Incentive winner cannot be requalified. Occurs when no allocated winning slots remain.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "API Key invalid or access denied.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Incentive or winner not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/influencers/{influencerId}/reward-wins": { "get": { "x-handler": "reward_wins/influencer_reward_wins_controller.js", "x-access": [ "administrator", "root" ], "tags": [ "RewardWins" ], "summary": "Retrieve all reward wins for an influencer.", "operationId": "getAllInfluencerRewardWins", "parameters": [ { "name": "influencerId", "in": "path", "type": "integer", "required": true }, { "name": "isFulfilled", "in": "query", "type": "boolean", "required": false }, { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" } ], "responses": { "200": { "description": "An array of reward wins.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/RewardWin" } } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "API Key invalid or access denied.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/influencers": { "get": { "tags": [ "Influencers" ], "x-handler": "influencers/influencer_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve a list of influencers.", "operationId": "getInfluencers", "parameters": [ { "name": "q", "in": "query", "type": "string", "description": "Search for influencer by first name, last name, and email." }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" } ], "responses": { "200": { "description": "An array of Influencer previews.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/InfluencerPreview" } } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/scheduled-notifications": { "get": { "x-handler": "/influencer_notifications/schedule_notification_controller.js", "operationId": "getScheduledNotifications", "summary": "Retrieve all scheduled notifications in a list format.", "x-access": [ "administrator" ], "parameters": [ { "name": "notificationDefinitionKeys", "in": "query", "description": "Select only scheduled notifications associated with these specified notification definition keys.", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderByParam" }, { "name": "sent", "in": "query", "type": "boolean" }, { "name": "beforeSendTime", "in": "query", "description": "Select only notifications scheduled to be sent prior to this date-time.", "type": "string", "format": "date-time" } ], "responses": { "200": { "description": "An array of scheduled notifications", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ScheduledNotification" }, "type": "array" } } } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] }, "post": { "x-handler": "influencer_notifications/schedule_notification_controller.js", "operationId": "createScheduledNotification", "summary": "Create a scheduled notification", "x-access": [ "administrator" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "notificationDefinitionKey", "sendTime" ], "properties": { "resourceId": { "description": "Identifier of the resource contexual to the the notification (e.g. ActionGroup id)", "type": "integer" }, "sendTime": { "type": "string", "format": "date-time", "description": "time to send notification" }, "notificationDefinitionKey": { "description": "notification definition key", "type": "string" } } } } ], "responses": { "200": { "description": "URI for scheduled notification", "schema": { "type": "object", "properties": { "id": { "type": "integer" } } } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] } }, "/scheduled-notifications/{id}": { "get": { "x-handler": "influencer_notifications/schedule_notification_controller.js", "operationId": "getScheduledNotification", "summary": "Retrieve a single scheduled notification.", "x-access": [ "administrator" ], "tags": [ "Notifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A scheduled notification.", "schema": { "$ref": "#/definitions/ScheduledNotification" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "x-handler": "influencer_notifications/schedule_notification_controller.js", "operationId": "updateScheduledNotification", "summary": "Update a scheduled notification. Notifications that have already been sent cannot be updated.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of scheduled notification", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ScheduledNotification" } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] }, "delete": { "x-handler": "influencer_notifications/schedule_notification_controller.js", "operationId": "deleteScheduledNotification", "summary": "Delete the specified scheduled notification. Notifications that have already been sent cannot be deleted.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of scheduled notification", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Empty object.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] } }, "/scheduled-notifications/{id}/approval": { "put": { "x-handler": "influencer_notifications/schedule_notification_approval_controller.js", "operationId": "approveScheduledNotification", "summary": "Approve a scheduled notification to be sent.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of scheduled notification", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] } }, "/scheduled-notifications/{id}/unapproval": { "put": { "x-handler": "influencer_notifications/schedule_notification_unapproval_controller.js", "operationId": "unapproveScheduledNotification", "summary": "Unapprove a scheduled notification to not be sent.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of scheduled notification", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Notifications" ] } }, "/action-groups/{id}/submissions": { "post": { "x-handler": "action_group_candidates/action_group_application_submission_controller.js", "x-access": [ "influencer" ], "summary": "Create a submission for an application.", "operationId": "submitApplication", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "data": { "$ref": "#/definitions/UserDataPoint" } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Either the campaign or audience was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Application" ] } }, "/action-groups/{id}/candidates": { "get": { "x-handler": "action_group_candidates/action_group_candidate_controller.js", "summary": "Retrieve all action group candidates.", "x-access": [ "administrator", "shared-cipher" ], "x-sharedCipherParameters": { "actionGroupId": "id" }, "operationId": "getAllActionGroupCandidates", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "$ref": "#/parameters/options" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "$ref": "#/parameters/userFilter" }, { "$ref": "#/parameters/q" }, { "$ref": "#/parameters/listStatusId" }, { "$ref": "#/parameters/listCustomStatusId" }, { "$ref": "#/parameters/listCustomInfluencerStatusId" }, { "$ref": "#/parameters/contentDueDate" }, { "$ref": "#/parameters/hasCompletedActivity" }, { "$ref": "#/parameters/hasOptedInToActivity" }, { "$ref": "#/parameters/isParticipatingInActivity" }, { "name": "includeInstagramPosts", "in": "query", "type": "boolean" }, { "name": "includeViewed", "in": "query", "type": "boolean" }, { "name": "includeCommentsCount", "in": "query", "type": "boolean" }, { "name": "includeDraftComments", "in": "query", "type": "boolean" }, { "name": "assessorEmail", "in": "query", "type": "string" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "statusId", "upvotes", "downvotes", "netVotes", "totalVotes", "dueDate", "optedInDate", "engagements", "createdAt", "customStatusId", "customInfluencerStatusId", "quote", "user.stageJoinDate", "user.id", "user.age", "user.audienceFakeEngagersLevel", "user.audienceFakeFollowersLevel", "user.audienceFraudLevel", "user.audiencePercentageFemale", "user.audiencePercentage_13_17", "user.audiencePercentage_18_24", "user.audiencePercentage_25_34", "user.audiencePercentage_35_44", "user.audiencePercentage_45_54", "user.audiencePercentage_55_64", "user.audiencePercentage_65_plus", "user.audiencePredominantAgeRange", "user.audiencePredominantCity", "user.audiencePredominantCountry", "user.birthday", "user.city", "user.country", "user.deleted", "user.email", "user.fullName", "user.gender", "user.instagramHandle", "user.lastRefreshedAt", "user.loadSource", "user.nudityLevel", "user.profanityLevel", "user.state", "user.violenceLevel", "listMemberCostAndPerformance.listMemberId", "listMemberCostAndPerformance.rewards", "listMemberCostAndPerformance.value", "listMemberCostAndPerformance.cost", "listMemberCostAndPerformance.posts", "listMemberCostAndPerformance.engagements", "listMemberCostAndPerformance.impressions", "listMemberCostAndPerformance.clicks", "listMemberCostAndPerformance.conversions", "listMemberCostAndPerformance.conversionValue", "listMemberCostAndPerformance.cpm", "listMemberCostAndPerformance.cpp", "listMemberCostAndPerformance.cpe", "listMemberCostAndPerformance.committedAmount", "listMemberCostAndPerformance.readyAmount", "listMemberCostAndPerformance.paidAmount", "listMemberCostAndPerformance.emvValue", "listMemberCostAndPerformance.roiValue", "user.instagramAccount.globalUserId", "user.instagramAccount.analysisVersion", "user.instagramAccount.audienceFakeCommentersLevel", "user.instagramAccount.audienceFakeCommentersPercentage", "user.instagramAccount.audienceFakeEngagersLevel", "user.instagramAccount.audienceFakeFollowersLevel", "user.instagramAccount.audienceFakeFollowersPercentage", "user.instagramAccount.audienceFakeLikersLevel", "user.instagramAccount.audienceFakeLikersPercentage", "user.instagramAccount.audienceFraudLevel", "user.instagramAccount.audiencePercentageFemale", "user.instagramAccount.audiencePercentage_13_17", "user.instagramAccount.audiencePercentage_18_24", "user.instagramAccount.audiencePercentage_25_34", "user.instagramAccount.audiencePercentage_35_44", "user.instagramAccount.audiencePercentage_45_54", "user.instagramAccount.audiencePercentage_55_64", "user.instagramAccount.audiencePercentage_65_plus", "user.instagramAccount.audiencePredominantAgeRange", "user.instagramAccount.audiencePredominantCity", "user.instagramAccount.audiencePredominantCountry", "user.instagramAccount.averageComments", "user.instagramAccount.averageEngagements", "user.instagramAccount.averageLikes", "user.instagramAccount.bio", "user.instagramAccount.boughtFollowers", "user.instagramAccount.createdAt", "user.instagramAccount.engagementRate", "user.instagramAccount.followersCount", "user.instagramAccount.followingCount", "user.instagramAccount.fullName", "user.instagramAccount.handle", "user.instagramAccount.instagramExternalId", "user.instagramAccount.instagramProfileId", "user.instagramAccount.isBusiness", "user.instagramAccount.isPrivate", "user.instagramAccount.lastAnalyzedAt", "user.instagramAccount.lastAnalyzedFollowersFraudAt", "user.instagramAccount.loadSource", "user.instagramAccount.mediaCount", "user.instagramAccount.nudityLevel", "user.instagramAccount.previewPostsLastUpdatedAt", "user.instagramAccount.profanityLevel", "user.instagramAccount.profilePicture", "user.instagramAccount.profileType", "user.instagramAccount.sourceDetail", "user.instagramAccount.sponsoredPostRate", "user.instagramAccount.topicsLastAnalyzedAt", "user.instagramAccount.updatedAt", "user.instagramAccount.violenceLevel", "user.instagramAccount.website", "user.facebookProfile.id", "user.facebookProfile.averageComments", "user.facebookProfile.averageEngagements", "user.facebookProfile.averageLikes", "user.facebookProfile.engagementRate", "user.facebookProfile.facebookExternalId", "user.facebookProfile.facebookCreator", "user.facebookProfile.link", "user.facebookProfile.name", "user.facebookProfile.picture", "user.facebookProfile.reach", "user.facebookProfile.type", "user.twitterAccount.id", "user.twitterAccount.userId", "user.twitterAccount.handle", "user.twitterAccount.fullName", "user.twitterAccount.profilePicture", "user.twitterAccount.description", "user.twitterAccount.followersCount", "user.twitterAccount.followingCount", "user.twitterAccount.listedCount", "user.twitterAccount.accountCreatedAt", "user.twitterAccount.location", "user.twitterAccount.geoEnabled", "user.twitterAccount.lang", "user.twitterAccount.timeZone", "user.twitterAccount.utcOffset", "user.twitterAccount.verified", "user.twitterAccount.protected", "user.twitterAccount.averageFavorites", "user.twitterAccount.averageRetweets", "user.twitterAccount.averageEngagements", "user.twitterAccount.engagementRate", "user.twitterAccount.primaryAccount", "user.twitterAccount.twitterExternalId", "user.twitterAccount.createdAt", "user.pinterestAccount.id", "user.pinterestAccount.averageEngagements", "user.pinterestAccount.bio", "user.pinterestAccount.boardsCount", "user.pinterestAccount.createdAt", "user.pinterestAccount.engagementRate", "user.pinterestAccount.externalId", "user.pinterestAccount.firstName", "user.pinterestAccount.followersCount", "user.pinterestAccount.followingCount", "user.pinterestAccount.lastName", "user.pinterestAccount.monthlyViewers", "user.pinterestAccount.pinsCount", "user.pinterestAccount.primaryAccount", "user.pinterestAccount.profilePicture", "user.pinterestAccount.updatedAt", "user.pinterestAccount.userId", "user.pinterestAccount.username", "user.blog.id", "user.blog.globalUserId", "user.blog.language", "user.blog.name", "user.blog.platform", "user.blog.url", "user.youtubeChannel.id", "user.youtubeChannel.userId", "user.youtubeChannel.username", "user.youtubeChannel.bio", "user.youtubeChannel.accountCreatedAt", "user.youtubeChannel.profilePicture", "user.youtubeChannel.followersCount", "user.youtubeChannel.videoCount", "user.youtubeChannel.commentCount", "user.youtubeChannel.viewCount", "user.youtubeChannel.primaryAccount", "user.youtubeChannel.youtubeExternalId", "user.youtubeChannel.handle", "user.youtubeChannel.global_user_id", "draftContent.id", "draftContent.text", "draftContent.listMemberId", "draftContent.createdAt", "draftContent.updatedAt", "draftContent.status", "draftContent.contentType", "draftContent.notes", "draftContent.contentUrl", "draftContent.isArchived", "draftContent.archivedByAccountId", "draftContent.archivedByGlobalUserId", "draftContent.archivedAt", "draftContent.threadId", "draftContent.feedback", "draftContent.uploaderType", "draftContent.uploaderAccountId", "draftContent.uploaderGlobalUserId", "user.tiktokCreator.followersCount", "user.tiktokCreator.engagementRate" ] } ], "responses": { "200": { "description": "An array of candidates for an action group", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ActionGroupCandidate" }, "type": "array" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Candidates" ] }, "put": { "x-handler": "action_group_candidates/action_group_candidate_status_change_controller.js", "x-access": [ "administrator" ], "tags": [ "Candidates" ], "summary": "Update the status of candidates.", "operationId": "updateInfluencersStatuses", "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "statusId" ], "properties": { "statusId": { "type": "integer" }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/candidates/{globalUserId}": { "get": { "x-handler": "action_group_candidates/action_group_candidate_controller.js", "summary": "Retrieve a candidate of an action group.", "x-access": [ "administrator" ], "operationId": "getActionGroupCandidate", "parameters": [ { "name": "actionGroupId", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "description": "ID of the global user", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A candidate of an action group", "schema": { "$ref": "#/definitions/ActionGroupCandidate" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Candidates" ] } }, "/action-groups/{actionGroupId}/candidates/{globalUserId}/conversations": { "get": { "tags": [ "ActionGroups" ], "x-handler": "action_group_candidates/candidate_conversation_controller.js", "x-access": [ "administrator" ], "operationId": "getActionGroupCandidateConversations", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "mostRecentMessageCreatedAt" ] }, { "name": "isArchived", "in": "query", "type": "boolean" }, { "name": "markedAsUnread", "in": "query", "type": "boolean" } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ConversationResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/Conversation" } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group or global user not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/bulk-opt-in": { "post": { "summary": "Opt-in candidates in bulk.", "x-handler": "action_group_candidates/bulk_opt_in_controller.js", "x-access": [ "administrator" ], "tags": [ "Candidates" ], "operationId": "bulkOptIn", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" }, "globalUserIds": { "type": "array", "items": { "type": "integer" } } } } } ], "responses": { "200": { "description": "Bulk opt in successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/confirm-participation": { "post": { "tags": [ "Candidates" ], "x-handler": "action_group_candidates/confirm_participation_controller.js", "x-access": [ "influencer" ], "summary": "Confirm participation/non-participation in an action group.", "operationId": "confirmActionGroupParticipation", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "participating" ], "properties": { "participating": { "type": "boolean" } } } } ], "responses": { "200": { "description": "Participation status updated.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/account/action-groups/{id}/subscriber-settings": { "put": { "tags": [ "ActionGroups" ], "operationId": "updateSubscriberSettingsForAccount", "x-handler": "action_group_subscribers/account_action_group_subscribers_controller.js", "x-access": [ "administrator" ], "summary": "Update subscriber settings for a campaign for an authenticated account.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "subscribed": { "type": "boolean" } } } } ], "responses": { "200": { "description": "Subscriber settings.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/bulk-message": { "post": { "tags": [ "ActionGroups" ], "operationId": "sendBulkMessageForActionGroup", "x-handler": "actions/action_group_bulk_message_controller.js", "x-access": [ "administrator" ], "summary": "Send a message to specified action group candidates.", "parameters": [ { "name": "actionGroupId", "type": "integer", "in": "path", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "subject": { "type": "string" }, "html": { "type": "string" }, "conversationTemplateId": { "type": "integer" }, "excludePastRecipients": { "type": "boolean" }, "addTalentManager": { "type": "boolean" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Message sent successfully.", "schema": { "type": "object", "properties": { "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/list-members/{globalUserId}": { "post": { "tags": [ "ActionGroups" ], "operationId": "sendMessageForActionGroup", "x-handler": "actions/action_group_message_controller.js", "x-access": [ "administrator" ], "summary": "Send a message to specified List Member.", "parameters": [ { "name": "actionGroupId", "type": "integer", "in": "path", "required": true }, { "name": "globalUserId", "type": "integer", "in": "path", "required": true }, { "$ref": "#/parameters/OutboundMessage" } ], "responses": { "200": { "description": "Message sent successfully.", "schema": { "type": "object", "properties": { "conversationId": { "type": "integer" }, "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/setup-alerts": { "get": { "tags": [ "ActionGroups" ], "operationId": "getSetupAlert", "summary": "If necessary, return campaign setup alert to marketer.", "x-handler": "actions/action_group_setup_alerts_controller.js", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "type": "integer", "required": true }, { "name": "alert", "in": "query", "type": "string", "required": true } ], "responses": { "200": { "description": "An alert.", "schema": { "properties": { "alert": { "type": "string" } } } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/referral-actions": { "put": { "tags": [ "Actions" ], "operationId": "updateReferralAction", "x-handler": "actions/referral_action_controller.js", "x-access": [ "administrator" ], "summary": "Create a Referral Action for an existing Activity.", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "$ref": "#/parameters/ReferralActionData" } ], "responses": { "200": { "description": "Referral Action updated successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "Actions" ], "operationId": "createReferralAction", "x-handler": "actions/referral_action_controller.js", "x-access": [ "administrator" ], "summary": "Create a Referral Action for an existing Activity.", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "$ref": "#/parameters/ReferralActionData" } ], "responses": { "200": { "description": "Referral Action created successfully.", "schema": { "$ref": "#/definitions/ActionDeprecated" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/activations": { "get": { "tags": [ "Activations" ], "operationId": "getActionGroupActivations", "x-handler": "activations/action_group_activation_controller.js", "x-access": [ "administrator", "influencer", "shared-cipher" ], "x-sharedCipherParameters": { "actionGroupId": "actionGroupId" }, "summary": "Fetch all activations for an action group", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "query", "type": "integer", "description": "The global user Id to filter the results by." }, { "name": "myActivations", "in": "query", "type": "boolean", "description": "Flag permitting the influencer to view unapproved and/or-only approved activations" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/postsWithUGC" }, { "$ref": "#/parameters/networkParam" }, { "$ref": "#/parameters/userFilter" }, { "$ref": "#/parameters/orderDirection" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "postDate", "createdAt", "engagements", "estimatedImpressions" ] }, { "name": "networks", "in": "query", "type": "array", "description": "Array of networks", "items": { "type": "string" } }, { "name": "postDateAfter", "in": "query", "type": "string", "description": "The activation post date is >= this date" }, { "name": "postDateBefore", "in": "query", "type": "string", "description": "The activation post date is <= this date" }, { "name": "filterTagIds", "in": "query", "type": "array", "description": "Array of tag ids used for searching activations", "items": { "type": "number" } }, { "name": "tagQuantifier", "in": "query", "type": "string", "description": "any or all option when searching for filterTagIds" }, { "name": "shouldExportFilenames", "in": "query", "type": "boolean", "description": "Whether or not to export the filenames of the activations" } ], "responses": { "200": { "description": "An array of activations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ActivationDeprecated" }, "type": "array" } } } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/activations": { "get": { "tags": [ "Activations" ], "operationId": "getActivations", "x-handler": "activations/activation_controller.js", "x-access": [ "influencer", "administrator" ], "summary": "Fetch all activations", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "postDate", "createdAt", "engagements", "estimatedImpressions" ] }, { "$ref": "#/parameters/orderDirection" }, { "$ref": "#/parameters/approvalStatus" }, { "$ref": "#/parameters/postsWithUGC" }, { "$ref": "#/parameters/networkParam" }, { "$ref": "#/parameters/userFilter" }, { "name": "networks", "in": "query", "type": "array", "description": "Array of networks", "items": { "type": "string" } }, { "name": "postDateAfter", "in": "query", "type": "string", "description": "The activation post date is >= this date" }, { "name": "postDateBefore", "in": "query", "type": "string", "description": "The activation post date is <= this date" }, { "name": "actionGroupId", "in": "query", "type": "array", "description": "Array of action group ids", "items": { "type": "number" } }, { "name": "showcaseMode", "in": "query", "type": "boolean", "description": "It's showcase time!" }, { "name": "globalUserId", "in": "query", "type": "integer", "description": "The global user Id to filter the results by." }, { "name": "filterTagIds", "in": "query", "type": "array", "description": "Array of tag ids used For searching activations", "items": { "type": "number" } }, { "name": "tagQuantifier", "in": "query", "type": "string", "description": "any or all option when searching for filterTagIds" }, { "name": "shouldExportFilenames", "in": "query", "type": "boolean", "description": "Whether or not to export the filenames of the activations" } ], "responses": { "200": { "description": "An array of activations.", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ActivationDeprecated" }, "type": "array" } } } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "Activations" ], "operationId": "createActivation", "x-access": [ "administrator" ], "x-handler": "activations/activation_controller.js", "summary": "Create an activation manually.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "globalUserId", "actionId", "instagramPostId" ], "properties": { "globalUserId": { "type": "integer" }, "actionId": { "type": "string" }, "instagramPostId": { "type": "string" }, "activation": { "$ref": "#/definitions/ActivationDeprecated" } } } } ], "responses": { "200": { "description": "Activation created successfully", "schema": { "$ref": "#/definitions/ActivationDeprecated" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Member or action not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "Activations" ], "operationId": "deleteAndExcludeActivation", "x-access": [ "administrator" ], "x-handler": "activations/activation_controller.js", "summary": "Delete this activation and exclude its content from being re-added to the action group", "parameters": [ { "name": "activationId", "in": "query", "type": "integer", "required": true }, { "name": "markIncomplete", "in": "query", "type": "boolean" }, { "name": "trackingStatusId", "in": "query", "type": "integer" } ], "responses": { "200": { "description": "Activation deleted successfully", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Activation not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/activations/{id}/": { "put": { "tags": [ "Activations" ], "operationId": "updateActivation", "x-handler": "activations/activation_controller.js", "x-access": [ "administrator" ], "summary": "Edit an activation.", "parameters": [ { "name": "id", "in": "path", "type": "string", "required": true }, { "$ref": "#/parameters/Activation" } ], "responses": { "200": { "description": "Activation edited successfully.", "schema": { "$ref": "#/definitions/ActivationDeprecated" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/self-reported-activation-notifications": { "post": { "tags": [ "Activations" ], "operationId": "selfReportActivationNotification", "x-handler": "activations/self_reported_activations/self_reported_activation_notification_controller.js", "x-access": [ "influencer" ], "summary": "\n Report information about an activation or content that could not be\n programmatically activated directly to the marketer", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "activationId": { "type": "integer" }, "comment": { "type": "string" } } } } ], "responses": { "200": { "description": "Activation notification reported successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/actions/{actionId}/manual-activations/{globalUserId}": { "post": { "tags": [ "Activations" ], "operationId": "createManualActivation", "x-handler": "activations/activation_manual_activate_controller.js", "x-access": [ "administrator" ], "summary": "Create manual activation for action.", "parameters": [ { "name": "actionId", "in": "path", "type": "string", "required": true }, { "name": "globalUserId", "in": "path", "type": "integer", "required": true }, { "$ref": "#/parameters/Activation" } ], "responses": { "200": { "description": "Activation created successfully.", "schema": { "$ref": "#/definitions/ActivationDeprecated" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/activity-history/{globalUserId}": { "get": { "tags": [ "ActivityHistory" ], "operationId": "getHistory", "x-handler": "activity_history/activity_history_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve a history.", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "name": "actionGroupId", "in": "path", "type": "integer", "required": true, "description": "The id of the activity to filter the result set by." }, { "name": "globalUserId", "in": "path", "type": "integer", "required": true, "description": "The id of the influencer to filter the result set by." }, { "name": "eventTypes", "in": "query", "type": "string", "required": false, "description": "A comma-separated list of event types to return. If not specified, then return default event types." }, { "name": "conversationId", "in": "query", "type": "integer", "required": false, "description": "A conversation's unique identifier." } ], "responses": { "200": { "description": "Activity History.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/ActivityHistory" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/api-key/facebook": { "post": { "tags": [ "Authentication" ], "x-handler": "auth/facebook_controller.js", "summary": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId" ], "properties": { "communityId": { "type": "string" }, "accessToken": { "type": "string" }, "code": { "type": "string", "description": "Authorization code from beginning of the OAuth flow." }, "redirectUri": { "type": "string", "description": "Redirect URI that facebook should redirect to after authorization. Must match the redirect URI from the first part of the flow." }, "referralSourceDomain": { "type": "string", "description": "The domain that the user came from when they logged in for the first time" }, "referringURL": { "type": "string" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmTerm": { "type": "string" }, "utmContent": { "type": "string" }, "utmCampaign": { "type": "string" }, "phone": { "type": "string" }, "abTestVariations": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "variation": { "type": "string" } } } }, "facebookPageIds": { "type": "array", "items": { "type": "string" } }, "shouldAddPages": { "type": "boolean" } } } }, { "name": "^mdp_.+$", "in": "query", "required": false, "type": "string", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ], "responses": { "200": { "description": "User info", "schema": { "properties": { "expiresAt": { "type": "string", "format": "date-time" }, "rejection": { "$ref": "#/definitions/MembershipRejection" }, "profile": { "$ref": "#/definitions/Profile" }, "token": { "type": "string" } } } }, "400": { "description": "Missing/invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/auto-login": { "post": { "tags": [ "Authentication" ], "x-handler": "auth/influencer_auto_login/influencer_auto_login_controller.js", "summary": "Pass encrypted user key in exchange for a JWT to include in the header of requests.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "Encrypted user key" }, "actionGroupId": { "type": "integer" } } } } ], "responses": { "200": { "description": "User info", "schema": { "properties": { "expiresAt": { "type": "string", "format": "date-time" }, "rejection": { "$ref": "#/definitions/MembershipRejection" }, "profile": { "$ref": "#/definitions/Profile" }, "token": { "type": "string" } } } }, "400": { "description": "Missing/invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Member not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/connected-account/instagram-business": { "post": { "tags": [ "Authentication" ], "x-handler": "auth/instagram_business_controller.js", "summary": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests.", "x-access": [ "influencer" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId" ], "properties": { "communityId": { "type": "string" }, "accessToken": { "type": "string" }, "code": { "type": "string", "description": "Authorization code from beginning of the OAuth flow." }, "redirectUri": { "type": "string", "description": "Redirect URI that facebook should redirect to after authorization. Must match the redirect URI from the first part of the flow." }, "facebookPageIds": { "type": "array", "items": { "type": "string" } } } } } ], "responses": { "200": { "description": "All Instagram Profiles and Facebook Profiles", "schema": { "properties": { "token": { "type": "string" }, "instagramProfiles": { "type": "array", "items": { "$ref": "#/definitions/InstagramConnectionInfo" } }, "facebookProfiles": { "type": "array", "items": { "$ref": "#/definitions/FacebookProfileDeprecated" } } } } }, "400": { "description": "Missing/invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/batch-jobs/{listId}/status": { "get": { "tags": [ "BatchJobs" ], "x-handler": "batch_jobs/batch_jobs_controller.js", "x-access": [ "administrator" ], "operationId": "getProgressForBatchJobsWithListId", "parameters": [ { "name": "listId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Collection of batch jobs with counts.", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/BatchJob" } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/batch-jobs/{communityId}/summary": { "get": { "tags": [ "BatchJobs" ], "x-handler": "batch_jobs/batch_jobs_controller.js", "x-access": [ "administrator" ], "operationId": "getBatchJobsSummary", "parameters": [ { "name": "communityId", "in": "path", "required": true, "type": "string" } ], "responses": { "200": { "description": "A summary of the running and completed batch jobs for an instance.", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/BatchJob" } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/community-benchmarks": { "get": { "tags": [ "CommunityBenchmarks" ], "operationId": "getCommunityBenchmarks", "x-handler": "benchmarks/community_benchmarks_controller.js", "x-access": [ "administrator", "shared-cipher" ], "summary": "Retrieves benchmarks for a community", "parameters": [ { "name": "fromDate", "in": "query", "type": "string", "required": false } ], "responses": { "200": { "description": "A collection of community benchmarks", "schema": { "properties": { "data": { "type": "object", "additionalProperties": {} } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/conversations/general-folders": { "get": { "tags": [ "Conversations" ], "operationId": "getGeneralFolders", "x-handler": "conversations/conversation_folders/conversation_folders_controller.js", "x-access": [ "administrator" ], "summary": "Get the General Folders Unread Counts.", "parameters": [ { "name": "keys", "in": "query", "type": "string", "required": true } ], "responses": { "200": { "description": "Static General Folders with unread count.", "schema": { "$ref": "#/definitions/GeneralFolders" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Conversation not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/conversations/dynamic-campaign-folders": { "get": { "tags": [ "Conversations" ], "operationId": "getCampaignFolders", "x-handler": "conversations/conversation_folders/conversation_folders_controller.js", "x-access": [ "administrator" ], "summary": "Get the General Folders Unread Counts.", "parameters": [ { "name": "keys", "in": "query", "type": "string", "required": true }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/CampaignFolder" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Conversation not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/messages/{id}": { "get": { "tags": [ "Conversations" ], "operationId": "getMessage", "x-handler": "conversations/message_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve a message by id.", "parameters": [ { "name": "id", "in": "path", "type": "string", "description": "The Id of the message to retrieve.", "required": true }, { "name": "includes", "in": "query", "type": "string", "description": "A comma-separated list of message dimensions to return. If not specified, then return standard dimensions." } ], "responses": { "200": { "description": "Retrieved the message.", "schema": { "$ref": "#/definitions/Message" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/draft": { "post": { "tags": [ "Conversations" ], "operationId": "createDraft", "x-handler": "conversations/drafts/draft_controller.js", "x-access": [ "administrator" ], "summary": "Send a new message.", "parameters": [ { "name": "replyToMessageId", "in": "query", "type": "integer", "required": false }, { "$ref": "#/parameters/OutboundMessage" } ], "responses": { "200": { "description": "Draft created successfully.", "schema": { "type": "object", "properties": { "conversationId": { "type": "integer" }, "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/draft/{messageId}": { "put": { "tags": [ "Conversations" ], "operationId": "updateDraft", "x-handler": "conversations/drafts/draft_controller.js", "x-access": [ "administrator" ], "summary": "Update the draft.", "parameters": [ { "name": "messageId", "in": "path", "type": "integer", "required": true }, { "$ref": "#/parameters/OutboundMessage" } ], "responses": { "200": { "description": "Draft updated successfully.", "schema": { "type": "object", "properties": { "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "Conversations" ], "operationId": "throwOutDraft", "x-handler": "conversations/drafts/draft_controller.js", "x-access": [ "administrator" ], "summary": "Throw out the draft.", "parameters": [ { "name": "messageId", "in": "path", "type": "integer", "required": true } ], "responses": { "200": { "description": "Draft thrown out successfully.", "schema": { "type": "object", "properties": { "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/sendMessage/{messageId}": { "put": { "tags": [ "Conversations" ], "operationId": "sendMessage", "x-handler": "conversations/message_send_outbound_controller.js", "x-access": [ "administrator" ], "summary": "Send a message.", "parameters": [ { "name": "messageId", "in": "path", "type": "integer", "required": true } ], "responses": { "200": { "description": "Message sent successfully.", "schema": { "type": "object", "properties": { "message": { "$ref": "#/definitions/Message" } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/messages/{messageId}/reply": { "post": { "tags": [ "Conversations" ], "operationId": "replyToMessage", "x-handler": "conversations/message_reply_controller.js", "x-access": [ "administrator" ], "summary": "Reply to a message.", "parameters": [ { "name": "messageId", "in": "path", "type": "integer", "required": true }, { "$ref": "#/parameters/OutboundMessage" } ], "responses": { "200": { "description": "Message sent successfully.", "schema": { "$ref": "#/definitions/Message" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/conversations": { "get": { "tags": [ "Conversations" ], "operationId": "getConversations", "x-handler": "conversations/conversation_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve conversations.", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "name": "search", "in": "query", "type": "string", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "mostRecentMessageCreatedAt" ] }, { "name": "isArchived", "in": "query", "type": "boolean" }, { "name": "markedAsUnread", "in": "query", "type": "boolean" } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ConversationResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/Conversation" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/find-all-conversations": { "get": { "tags": [ "Conversations" ], "operationId": "findAllConversations", "x-handler": "conversations/conversation_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve conversations.", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "name": "search", "in": "query", "type": "string", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "mostRecentMessageCreatedAt" ] }, { "name": "isArchived", "in": "query", "type": "boolean" }, { "name": "markedAsUnread", "in": "query", "type": "boolean" } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ConversationResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/Conversation" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/count-conversations": { "get": { "tags": [ "Conversations" ], "operationId": "countConversations", "x-handler": "conversations/conversation_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve conversations.", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderDirection" }, { "name": "search", "in": "query", "type": "string", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "mostRecentMessageCreatedAt" ] }, { "name": "isArchived", "in": "query", "type": "boolean" }, { "name": "markedAsUnread", "in": "query", "type": "boolean" } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ConversationResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/Conversation" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/conversations/{id}": { "get": { "tags": [ "Conversations" ], "operationId": "getConversation", "x-handler": "conversations/conversation_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve a conversation by id.", "parameters": [ { "name": "id", "in": "path", "type": "string", "description": "The Id of the conversation to retrieve.", "required": true }, { "name": "includes", "in": "query", "type": "string", "description": "A comma-separated list of conversation dimensions to return. If not specified, then return standard dimensions." } ], "responses": { "200": { "description": "Collection of conversations.", "schema": { "$ref": "#/definitions/Conversation" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Conversation not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/data-point-definitions": { "get": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "getDatapoints", "summary": "Retrieve all datapoints restricted by community and various parameters.", "x-access": [ "administrator" ], "parameters": [ { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/orderByParam" }, { "name": "name", "type": "string", "in": "query" }, { "name": "description", "type": "string", "in": "query" }, { "name": "key", "type": "string", "in": "query" }, { "name": "customSet", "type": "boolean", "in": "query" }, { "name": "type", "type": "string", "in": "query" }, { "name": "archived", "type": "array", "items": { "type": "boolean" }, "in": "query" }, { "name": "includeActiveActionGroups", "type": "boolean", "in": "query" }, { "$ref": "#/parameters/userFilter" }, { "$ref": "#/parameters/q" }, { "name": "orderProperty", "type": "string", "in": "query", "enum": [ "createdAt", "id", "age", "audienceFakeEngagersLevel", "audienceFakeFollowersLevel", "audienceFraudLevel", "audiencePercentageFemale", "audiencePercentage_13_17", "audiencePercentage_18_24", "audiencePercentage_25_34", "audiencePercentage_35_44", "audiencePercentage_45_54", "audiencePercentage_55_64", "audiencePercentage_65_plus", "audiencePredominantAgeRange", "audiencePredominantCity", "audiencePredominantCountry", "birthday", "city", "country", "deleted", "email", "fullName", "gender", "instagramHandle", "lastRefreshedAt", "loadSource", "nudityLevel", "profanityLevel", "state", "violenceLevel", "instagramAccount.globalUserId", "instagramAccount.analysisVersion", "instagramAccount.audienceFakeCommentersLevel", "instagramAccount.audienceFakeCommentersPercentage", "instagramAccount.audienceFakeEngagersLevel", "instagramAccount.audienceFakeFollowersLevel", "instagramAccount.audienceFakeFollowersPercentage", "instagramAccount.audienceFakeLikersLevel", "instagramAccount.audienceFakeLikersPercentage", "instagramAccount.audienceFraudLevel", "instagramAccount.audiencePercentageFemale", "instagramAccount.audiencePercentage_13_17", "instagramAccount.audiencePercentage_18_24", "instagramAccount.audiencePercentage_25_34", "instagramAccount.audiencePercentage_35_44", "instagramAccount.audiencePercentage_45_54", "instagramAccount.audiencePercentage_55_64", "instagramAccount.audiencePercentage_65_plus", "instagramAccount.audiencePredominantAgeRange", "instagramAccount.audiencePredominantCity", "instagramAccount.audiencePredominantCountry", "instagramAccount.averageComments", "instagramAccount.averageEngagements", "instagramAccount.averageLikes", "instagramAccount.bio", "instagramAccount.boughtFollowers", "instagramAccount.createdAt", "instagramAccount.engagementRate", "instagramAccount.followersCount", "instagramAccount.followingCount", "instagramAccount.fullName", "instagramAccount.handle", "instagramAccount.instagramExternalId", "instagramAccount.instagramProfileId", "instagramAccount.isBusiness", "instagramAccount.isPrivate", "instagramAccount.lastAnalyzedAt", "instagramAccount.lastAnalyzedFollowersFraudAt", "instagramAccount.loadSource", "instagramAccount.mediaCount", "instagramAccount.nudityLevel", "instagramAccount.previewPostsLastUpdatedAt", "instagramAccount.profanityLevel", "instagramAccount.profilePicture", "instagramAccount.profileType", "instagramAccount.sourceDetail", "instagramAccount.sponsoredPostRate", "instagramAccount.topicsLastAnalyzedAt", "instagramAccount.updatedAt", "instagramAccount.violenceLevel", "instagramAccount.website", "facebookProfile.id", "facebookProfile.averageComments", "facebookProfile.averageEngagements", "facebookProfile.averageLikes", "facebookProfile.engagementRate", "facebookProfile.facebookExternalId", "facebookProfile.facebookCreator", "facebookProfile.link", "facebookProfile.name", "facebookProfile.picture", "facebookProfile.reach", "facebookProfile.type", "twitterAccount.id", "twitterAccount.userId", "twitterAccount.handle", "twitterAccount.fullName", "twitterAccount.profilePicture", "twitterAccount.description", "twitterAccount.followersCount", "twitterAccount.followingCount", "twitterAccount.listedCount", "twitterAccount.accountCreatedAt", "twitterAccount.location", "twitterAccount.geoEnabled", "twitterAccount.lang", "twitterAccount.timeZone", "twitterAccount.utcOffset", "twitterAccount.verified", "twitterAccount.protected", "twitterAccount.averageFavorites", "twitterAccount.averageRetweets", "twitterAccount.averageEngagements", "twitterAccount.engagementRate", "twitterAccount.primaryAccount", "twitterAccount.twitterExternalId", "twitterAccount.createdAt", "pinterestAccount.id", "pinterestAccount.averageEngagements", "pinterestAccount.bio", "pinterestAccount.boardsCount", "pinterestAccount.createdAt", "pinterestAccount.engagementRate", "pinterestAccount.externalId", "pinterestAccount.firstName", "pinterestAccount.followersCount", "pinterestAccount.followingCount", "pinterestAccount.lastName", "pinterestAccount.monthlyViewers", "pinterestAccount.pinsCount", "pinterestAccount.primaryAccount", "pinterestAccount.profilePicture", "pinterestAccount.updatedAt", "pinterestAccount.userId", "pinterestAccount.username", "blog.id", "blog.globalUserId", "blog.language", "blog.name", "blog.platform", "blog.url", "youtubeChannel.id", "youtubeChannel.userId", "youtubeChannel.username", "youtubeChannel.bio", "youtubeChannel.accountCreatedAt", "youtubeChannel.profilePicture", "youtubeChannel.followersCount", "youtubeChannel.videoCount", "youtubeChannel.commentCount", "youtubeChannel.viewCount", "youtubeChannel.primaryAccount", "youtubeChannel.youtubeExternalId", "youtubeChannel.handle", "youtubeChannel.global_user_id", "user.stageJoinDate" ] } ], "responses": { "200": { "description": "An array of datapoints", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/DataPointDefinitionDeprecated" }, "type": "array" } } } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Datapoints" ] }, "post": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "createDataPointDefinition", "summary": "Create or edit a datapoint definition and any custom set of responses.", "x-access": [ "administrator" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } } ], "responses": { "200": { "description": "Returns the datapoint definition and its set of responses", "schema": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Datapoints" ] } }, "/data-point-definitions/{id}": { "get": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "getDataPointDefinition", "summary": "Retrieve a single data point definition.", "x-access": [ "administrator" ], "tags": [ "Datapoints" ], "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A data point.", "schema": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "updateDataPointDefinition", "summary": "Update a data point definition. Data point definitions that have been assigned cannot be updated.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of data point definition", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Resource conflict.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Datapoints" ] }, "delete": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "deleteDataPointDefinition", "summary": "Delete the data point definition. Data point definitions that have been assigned cannot be deleted.", "x-access": [ "administrator" ], "parameters": [ { "name": "id", "in": "path", "description": "Id of data point definition", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Empty object.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Validation error.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Scheduled notification not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Datapoints" ] } }, "/data-point-definitions/bulkUpdate": { "put": { "x-handler": "data_points/data_point_definition_controller.js", "operationId": "bulkUpdate", "summary": "Updates a specified field to a certain value for a set of a datapoints", "x-access": [ "administrator" ], "parameters": [ { "name": "data", "in": "body", "description": "Id's of datapoints", "required": true, "schema": { "type": "object", "properties": { "dataPointIds": { "description": "An array of datapoint id's to be updated", "type": "array", "items": { "type": "integer" } }, "dataPointData": { "description": "An object containing the desired fields and desired values as key value pairs. For example: {archived: true}", "type": "object", "properties": { "archived": { "type": "boolean" }, "mergeTag": { "type": "boolean" } } } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Datapoint resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } }, "tags": [ "Datapoints" ] } }, "/data-subject-request/": { "post": { "tags": [ "DataSubjectRequest" ], "operationId": "create", "x-handler": "data_subject_requests/data_subject_request_controller.js", "x-access": [ "influencer", "anonymous" ], "summary": "Creates or updates a data subject request", "parameters": [ { "name": "data", "in": "body", "required": true, "description": "Type of request", "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "GLOBAL_UNSUBSCRIBE", "GLOBAL_SUBSCRIBE", "DELETE", "EXPORT", "SUBSCRIBE", "UNSUBSCRIBE" ] } } } }, { "name": "id", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "type": "object", "properties": { "contact_info": { "type": "object", "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "activations": { "type": "array", "items": { "$ref": "#/definitions/ActivationDeprecated" } }, "rewards": { "type": "array", "items": { "$ref": "#/definitions/IncentiveDeprecated" } } } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-auth/lookup": { "post": { "tags": [ "Authentication" ], "x-handler": "email_auth/email_auth_lookup_controller.js", "summary": "Pass an email and check if it needs verification or existing login credentials submitted in order to proceed", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId", "email" ], "properties": { "communityId": { "type": "string" }, "email": { "type": "string" }, "actionGroupId": { "type": "integer" }, "referralSourceDomain": { "type": "string", "description": "The domain that the user came from when they logged in for the first time" }, "redirectUrl": { "type": "string" }, "referringURL": { "type": "string" }, "utmSource": { "type": "string" }, "utmMedium": { "type": "string" }, "utmTerm": { "type": "string" }, "utmContent": { "type": "string" }, "utmCampaign": { "type": "string" } } } }, { "name": "^mdp_.+$", "in": "query", "required": false, "type": "string", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ], "responses": { "200": { "description": "Email was found.", "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the next step for the client to perform.", "enum": [ "userOwnsEmail", "loginCredentialsRequired", "emailVerificationRequestInitiated", "emailOwnedByAnotherUser" ] } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-auth/signup": { "post": { "tags": [ "Authentication" ], "x-handler": "email_auth/email_auth_signup_controller.js", "summary": "Pass an email verification request key and new password in exchange for a JWT to include in the header of requests.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "key", "password" ], "properties": { "key": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "User Info.", "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the next step for the client to perform.", "enum": [ "loginCredentialsExist", "authenticationRequired", "createLoginCredentialsRequired", "usersDoNotMatch" ] }, "authenticationOptions": { "type": "array", "description": "If authentication is required before proceeding present what types of login are acceptable (facebook or/and email)", "items": { "type": "string", "enum": [ "facebook", "email" ] } }, "profile": { "$ref": "#/definitions/Profile" }, "token": { "type": "string" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-auth/login": { "post": { "tags": [ "Authentication" ], "x-handler": "email_auth/email_auth_login_controller.js", "summary": "Pass an email and password in exchange for a JWT to include in the header of requests.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId", "email", "password" ], "properties": { "communityId": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" } } } }, { "name": "^mdp_.+$", "in": "query", "required": false, "type": "string", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ], "responses": { "200": { "description": "User Info.", "schema": { "type": "object", "properties": { "profile": { "$ref": "#/definitions/Profile" }, "token": { "type": "string" }, "rejection": { "$ref": "#/definitions/MembershipRejection" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "User not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-auth/forgot-password": { "post": { "tags": [ "Authentication" ], "x-handler": "email_auth/email_auth_forgot_password_controller.js", "summary": "Initiate a forgot password password request", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "communityId", "email" ], "properties": { "communityId": { "type": "string" }, "email": { "type": "string" }, "actionGroupId": { "type": "integer" } } } } ], "responses": { "200": { "description": "Forgot password email sent.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-auth/reset-password": { "post": { "tags": [ "Authentication" ], "x-handler": "email_auth/email_auth_reset_password_controller.js", "summary": "Pass an email reset password request key and new password in exchange for a JWT to include in the header of requests.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "key", "password" ], "properties": { "key": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "User Info.", "schema": { "type": "object", "properties": { "profile": { "$ref": "#/definitions/Profile" }, "token": { "type": "string" }, "actionGroupId": { "type": "integer" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-verification-request/validate": { "post": { "tags": [ "Authentication" ], "x-handler": "email_verification_request/email_verification_request_validate_controller.js", "summary": "Validate an email verification request.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string" } } } } ], "responses": { "200": { "description": "Email verification request is valid.", "schema": { "type": "object", "properties": { "status": { "type": "string", "description": "Status of the next step for the client to perform.", "enum": [ "loginCredentialsExist", "authenticationRequired", "createLoginCredentialsRequired", "usersDoNotMatch" ] }, "authenticationOptions": { "type": "array", "description": "If authentication is required before proceeding present what types of login are acceptable (facebook or/and email)", "items": { "type": "string", "enum": [ "facebook", "email" ] } }, "user": { "type": "object", "properties": { "email": { "type": "string" }, "fullName": { "type": "string" } } }, "emailVerificationRequest": { "type": "object", "properties": { "actionGroupId": { "type": "integer" }, "redirectUrl": { "type": "string" } } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/email-verification-request/create": { "post": { "tags": [ "Authentication" ], "x-handler": "email_verification_request/email_verification_request_controller.js", "x-access": [ "influencer" ], "summary": "Create an Email Verification Request", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string" }, "actionGroupId": { "type": "integer" } } } } ], "responses": { "200": { "description": "request is valid", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/facebook-profiles": { "get": { "tags": [ "FacebookProfiles" ], "operationId": "getFacebookProfiles", "x-handler": "facebook_profiles/facebook_profile_controller.js", "x-access": [ "influencer" ], "summary": "Retrieve Facebook profiles.", "responses": { "200": { "description": "Collection of Facebook profiles.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/FacebookProfileDeprecated" } } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/facebook-profiles/{facebookProfileId}/active": { "post": { "tags": [ "FacebookProfiles" ], "operationId": "activateFacebookProfile", "x-handler": "facebook_profiles/active_facebook_profile_controller.js", "x-access": [ "influencer" ], "summary": "Designate a Facebook profile as active.", "parameters": [ { "name": "facebookProfileId", "in": "path", "type": "integer", "required": true } ], "responses": { "200": { "description": "Profile successfully designated as active.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Facebook profile not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/facebook-profiles/update-profile-picture": { "post": { "tags": [ "FacebookProfile" ], "operationId": "updateFacebookProfilePicture", "x-handler": "facebook_profiles/facebook_profile_controller.js", "x-access": [], "summary": "Updates facebook account profile picture", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "array", "items": { "type": "object", "properties": { "facebookProfileId": { "type": "number" }, "imageUrl": { "type": "string" } } } } } ], "responses": { "200": { "description": "Change successful", "schema": { "type": "object" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/candidates/global-user-lists/{globalUserListId}/members": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "createGlobalUserListMemberFromCandidates", "x-handler": "global_user_lists/global_user_list_member_controller.js", "x-access": [ "administrator" ], "summary": "Add candidates of an action group to a global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the action group that influencers are candidates of." }, { "name": "globalUserListId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Members added successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "GlobalUserLists" ], "operationId": "moveGlobalUserListMemberFromCandidates", "x-handler": "global_user_lists/global_user_list_member_controller.js", "x-access": [ "administrator" ], "summary": "Move candidates of an action group from one global user list to another.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the action group that influencers are candidates of." }, { "name": "globalUserListId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "fromGlobalUserListIds" ], "properties": { "fromGlobalUserListIds": { "type": "array", "items": { "type": "integer" } }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Members moved successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/candidates/global-user-lists/members/remove": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "deleteGlobalUserListMemberFromCandidates", "x-handler": "global_user_lists/global_user_list_member_remove_controller.js", "x-access": [ "administrator" ], "summary": "Remove candidates of an action group from global user lists.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the action group that influencers are candidates of." }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "globalUserListId" ], "properties": { "globalUserListId": { "type": "array", "items": { "type": "integer" } }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Members removed successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists": { "get": { "tags": [ "GlobalUserLists" ], "operationId": "getGlobalUserLists", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve global user lists.", "parameters": [ { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "$ref": "#/parameters/labelParam" }, { "name": "isArchived", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Collection of global user lists.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/GlobalUserList" } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "GlobalUserLists" ], "operationId": "createGlobalUserList", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Create a global user list.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "label" ], "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 50 } } } } ], "responses": { "200": { "description": "GlobalUserList URI.", "schema": { "type": "object", "properties": { "id": { "type": "integer" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists/{id}": { "get": { "tags": [ "GlobalUserLists" ], "operationId": "getGlobalUserListById", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve a single global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A single global user list.", "schema": { "$ref": "#/definitions/GlobalUserList" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "GlobalUserLists" ], "operationId": "updateGlobalUserList", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Update a global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/GlobalUserList" } } ], "responses": { "200": { "description": "Update successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "GlobalUserLists" ], "operationId": "destroyGlobalUserList", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Delete a global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Delete successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists/{id}/archive": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "archiveGlobalUserList", "x-handler": "global_user_lists/global_user_list_definition_archive_controller.js", "x-access": [ "administrator" ], "summary": "Archive a global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Archive successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists/{id}/unarchive": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "unarchiveGlobalUserList", "x-handler": "global_user_lists/global_user_list_definition_unarchive_controller.js", "x-access": [ "administrator" ], "summary": "Unarchive a global user list.", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Unarchive successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user/{globalUserId}/lists": { "get": { "tags": [ "GlobalUsers" ], "operationId": "getListsForGlobalUser", "x-handler": "global_user_lists/global_user_list_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve all lists associated with this global user.", "parameters": [ { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "name": "isArchived", "in": "query", "required": false, "type": "boolean" }, { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" } ], "responses": { "200": { "description": "A collection of lists.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/GlobalUserList" } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists/{globalUserListId}/members": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "createGlobalUserListMember", "x-handler": "global_user_lists/global_user_list_member_controller.js", "x-access": [ "administrator" ], "summary": "Add members to a global user list.", "parameters": [ { "name": "globalUserListId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "searchState": { "type": "object", "description": "Capture Search State for analytics" }, "queryFilter": { "$ref": "#/definitions/UserQueryFilter" } } } } ], "responses": { "200": { "description": "Members added successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "GlobalUserLists" ], "operationId": "moveGlobalUserListMember", "x-handler": "global_user_lists/global_user_list_member_controller.js", "x-access": [ "administrator" ], "summary": "Move members from one global user list to another.", "parameters": [ { "name": "globalUserListId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "fromGlobalUserListIds" ], "properties": { "fromGlobalUserListIds": { "type": "array", "items": { "type": "integer" } }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/UserQueryFilter" } } } } ], "responses": { "200": { "description": "Members moved successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-user-lists/members-remove": { "post": { "tags": [ "GlobalUserLists" ], "operationId": "deleteGlobalUserListMember", "x-handler": "global_user_lists/global_user_list_member_remove_controller.js", "x-access": [ "administrator" ], "summary": "Remove members from global user lists.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "globalUserListId" ], "properties": { "globalUserListId": { "type": "array", "items": { "type": "integer" } }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/UserQueryFilter" } } } } ], "responses": { "200": { "description": "Members removed successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user list not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-users/summary": { "get": { "tags": [ "GlobalUsers" ], "operationId": "getGlobalUsersSummary", "x-handler": "global_users_summary/global_users_summary_controller.js", "x-access": [ "administrator", "root" ], "summary": "Retrieve summary of global users.", "parameters": [ { "$ref": "#/parameters/userFilter" }, { "$ref": "#/parameters/q" }, { "$ref": "#/parameters/searchKeywords" } ], "responses": { "200": { "description": "A summary of global users data.", "schema": { "type": "object", "properties": { "avg_metrics": { "type": "object", "properties": { "members": { "type": "integer" }, "totalReach": { "type": "number" }, "averageFollowers": { "type": "number" }, "averageEngagementRate": { "type": "number" } } }, "top_influencers": { "type": "array", "items": { "$ref": "#/definitions/GlobalUserDeprecated" } }, "topics": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "gender_age": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "country": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "audience_gender": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "fraud_levels": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "audience_country": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "audience_city": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "audience_age": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "reach": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "top_hashtags": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Age_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_BrandInfluences_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_City_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Country_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_EducationOrganization_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_EducationStatus_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Employer_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Favorite_MusicBands_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Favorite_MusicGenre_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Favorite_MusicSoloArtist_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Gender_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Industry_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Language_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_LikesAndInterests_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_MaritalStatus_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_ParentalStatus_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_MediaInfluences_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Occupation_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_PeopleInfluences_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_PersonalIncome_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_Race_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_SportTeamSupported_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_SportsFollowed_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } }, "DemographicsPro_Audience_State_Max": { "type": "array", "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{campaignId}/influencer-contract-templates": { "get": { "tags": [ "InfluencerContractCampaignTemplates" ], "operationId": "getCampaignTemplate", "summary": "Get influencer contract template for this action group, referred to as a campaign client-side.", "x-handler": "influencer_contracts/campaign_templates/influencer_contract_campaign_template_controller.js", "x-access": [ "administrator" ], "parameters": [ { "name": "campaignId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "This campaign's influencer contract template.", "schema": { "$ref": "#/definitions/InfluencerContractCampaignTemplate" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "post": { "tags": [ "InfluencerContractCampaignTemplates" ], "x-access": [ "administrator" ], "x-handler": "influencer_contracts/campaign_templates/influencer_contract_campaign_template_controller.js", "operationId": "createCampaignTemplate", "summary": "Create an influencer contract template for this campaign.", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Influencer contract template successfully created for this action group, referred to as a campaign client-side.", "schema": { "$ref": "#/definitions/InfluencerContractCampaignTemplate" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{campaignId}/influencer-contract-templates/{id}": { "put": { "tags": [ "InfluencerContractCampaignTemplates" ], "x-access": [ "administrator" ], "x-handler": "influencer_contracts/campaign_templates/influencer_contract_campaign_template_controller.js", "operationId": "updateCampaignTemplate", "summary": "Generate a contract for this campaign, and update this campaign's template if necessary.", "parameters": [ { "name": "campaignId", "in": "path", "required": true, "type": "integer" }, { "name": "id", "in": "path", "required": true, "type": "integer" }, { "$ref": "#/parameters/InfluencerContractCampaignTemplate" } ], "responses": { "200": { "description": "A campaign-level influencer template.", "schema": { "$ref": "#/definitions/InfluencerContractCampaignTemplate" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/influencer-contract-templates": { "get": { "tags": [ "InfluencerContractCommunityTemplates" ], "operationId": "getCommunityTemplate", "summary": "Get influencer contract template for this community.", "x-handler": "influencer_contracts/community_templates/influencer_contract_community_template_controller.js", "x-access": [ "administrator" ], "responses": { "200": { "description": "This community's influencer contract template.", "schema": { "$ref": "#/definitions/InfluencerContractCommunityTemplate" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/influencer-contract-templates/{id}": { "put": { "tags": [ "InfluencerContractCommunityTemplates" ], "x-access": [ "administrator" ], "x-handler": "influencer_contracts/community_templates/influencer_contract_community_template_controller.js", "operationId": "updateCommunityTemplate", "summary": "Update this community's influencer contract template", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "integer" }, { "$ref": "#/parameters/InfluencerContractCommunityTemplate" } ], "responses": { "200": { "description": "A community-level influencer template.", "schema": { "$ref": "#/definitions/InfluencerContractCommunityTemplate" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/audience-city-options": { "get": { "summary": "Retrieve possible cities to search for", "tags": [ "GlobalUserAudience" ], "operationId": "getAudienceCityOptions", "x-access": [ "administrator" ], "x-handler": "instagram/instagram_audience_insights_options/instagram_audience_city_options_controller.js", "parameters": [ { "$ref": "#/parameters/limitParam" }, { "in": "query", "name": "city", "required": false, "type": "string" } ], "responses": { "200": { "description": "Collection of cities", "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "City not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/bulk-assign-custom-statuses": { "post": { "tags": [ "ActionGroupCustomStatuses" ], "x-handler": "list_custom_statuses/action_group_custom_status_bulk_application_controller.js", "x-access": [ "administrator" ], "operationId": "bulkAssignActionGroupCustomStatuses", "summary": "Assign an action group custom status to candidates in bulk.", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "customStatusId" ], "properties": { "customStatusId": { "type": [ "integer", "null" ] }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Custom status assigned successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/bulk-assign-custom-influencer-statuses": { "post": { "tags": [ "ActionGroupCustomInfluencerStatuses" ], "x-handler": "list_custom_statuses/action_group_custom_influencer_status_bulk_application_controller.js", "x-access": [ "administrator" ], "operationId": "bulkAssignActionGroupCustomInfluencerStatuses", "summary": "Assign an action group custom influencer status to candidates in bulk.", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "customInfluencerStatusId" ], "properties": { "customInfluencerStatusId": { "type": [ "integer", "null" ] }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Custom influencer status assigned successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{actionGroupId}/assign-custom-influencer-statuses": { "post": { "tags": [ "ActionGroupCustomInfluencerStatuses" ], "x-handler": "list_custom_statuses/action_group_custom_influencer_status_application_controller.js", "x-access": [ "administrator", "influencer" ], "operationId": "assignCustomInfluencerStatus", "summary": "Assign an action group custom influencer status to a candidate", "parameters": [ { "name": "actionGroupId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "customInfluencerStatusId" ], "properties": { "customInfluencerStatusId": { "type": [ "integer", "null" ] }, "comment": { "type": "string" } } } } ], "responses": { "200": { "description": "Custom influencer status assigned successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-members/{actionGroupId}": { "get": { "tags": [ "ListMember" ], "x-handler": "lists/list_member_controller.js", "summary": "Retrieve an action group's list members.", "x-access": [ "administrator" ], "operationId": "getListMembers", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "participating", "in": "query", "type": "boolean" }, { "$ref": "#/parameters/orderByParam" }, { "$ref": "#/parameters/orderDirection" } ], "responses": { "200": { "description": "An array of list members", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/ListMemberDeprecated" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "ListMember" ], "x-handler": "lists/list_member_controller.js", "x-access": [ "administrator" ], "operationId": "updateListMembers", "summary": "Update multiple list members.", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "dueDate": { "type": "string" }, "draftDueDate": { "type": "string" }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "List members updated successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "One or more list members not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-members/{actionGroupId}/{globalUserId}": { "get": { "tags": [ "ListMember" ], "operationId": "getListMember", "summary": "Retrieve a list member.", "x-handler": "lists/list_member_controller.js", "x-access": [ "administrator" ], "parameters": [ { "name": "actionGroupId", "in": "path", "description": "ID of action group", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A candidate", "schema": { "$ref": "#/definitions/ActionGroupCandidate" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group or candidate not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "ListMember" ], "x-handler": "lists/list_member_controller.js", "x-access": [ "administrator" ], "operationId": "updateListMember", "summary": "Update a list member.", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" }, { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "name": "data", "in": "body", "schema": { "type": "object", "properties": { "proposal": { "type": "object", "properties": { "concept": { "type": "string" }, "quote": { "type": "number", "format": "double" }, "comment": { "type": "string" } }, "required": [ "comment" ] } } } } ], "responses": { "200": { "description": "List member updated successfully.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "List member not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/login-credentials/update": { "put": { "tags": [ "Authentication" ], "x-handler": "login_credentials/login_credentials_controller.js", "x-access": [ "influencer" ], "summary": "Update existing influencer login credentials.", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "newPassword" ], "properties": { "oldPassword": { "type": "string" }, "newPassword": { "type": "string" } } } } ], "responses": { "200": { "description": "User Info.", "schema": { "type": "object", "properties": { "profile": { "$ref": "#/definitions/Profile" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/community-metrics": { "get": { "tags": [ "CommunityMetrics" ], "operationId": "getCommunityMetrics", "x-handler": "metrics/community_metrics_controller.js", "x-access": [ "administrator" ], "summary": "Retrieve community metrics", "parameters": [], "responses": { "200": { "description": "Collection of community metrics.", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "$ref": "#/definitions/CommunityMetric" } } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Metrics were not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/community-metrics/{metricId}": { "put": { "tags": [ "CommunityMetrics" ], "operationId": "enableCommunityMetric", "x-handler": "metrics/community_metrics_controller.js", "x-access": [ "administrator" ], "summary": "Enable a single metric", "parameters": [ { "name": "metricId", "in": "path", "required": true, "type": "integer", "description": "Metric Id" } ], "responses": { "200": { "description": "Update successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Metric was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "delete": { "tags": [ "CommunityMetrics" ], "operationId": "disableCommunityMetric", "x-handler": "metrics/community_metrics_controller.js", "x-access": [ "administrator" ], "summary": "Disable a single metric", "parameters": [ { "name": "metricId", "in": "path", "required": true, "type": "integer", "description": "Metric Id" } ], "responses": { "200": { "description": "Update successful.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Metric was not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/paypal-account/{membershipId}": { "get": { "tags": [ "PayPalAccount" ], "operationId": "getMemberPayPalAccount", "x-handler": "paypal/paypal_account_controller.js", "x-access": [ "administrator" ], "summary": "Get a PayPal account for a member.", "parameters": [ { "name": "membershipId", "in": "path", "type": "integer", "required": true } ], "responses": { "200": { "description": "A PayPal account for a member.", "schema": { "type": "object", "properties": { "email": { "type": "string" }, "isEnabled": { "type": "boolean" } } } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "PayPalAccount" ], "operationId": "upsertMemberPayPalAccount", "x-handler": "paypal/paypal_account_controller.js", "x-access": [ "administrator" ], "summary": "Upsert a PayPal account for a member.", "parameters": [ { "name": "membershipId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "email": { "type": [ "string", "null" ] }, "isEnabled": { "type": "boolean" } } } } ], "responses": { "200": { "description": "Empty object", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Missing or invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/referral-program": { "get": { "tags": [ "ReferralProgram" ], "operationId": "getPrimaryReferralActivity", "x-handler": "referral_programs/referral_program_controller.js", "x-access": [ "administrator", "influencer" ], "summary": "Retrieve a community's referral program activity", "parameters": [ { "name": "communityId", "in": "query", "required": false, "type": "string" } ], "responses": { "200": { "description": "Referral program activity returned.", "schema": { "$ref": "#/definitions/ActionGroupDeprecated" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "ReferralProgram" ], "operationId": "updateReferralProgram", "x-handler": "referral_programs/referral_program_controller.js", "x-access": [ "administrator" ], "summary": "Update a community's referral program incentives", "parameters": [ { "name": "data", "required": true, "in": "body", "schema": { "type": "object", "properties": { "sharingDescription": { "type": "string" }, "referrerId": { "type": "integer" }, "refereeId": { "type": "integer" } } } } ], "responses": { "200": { "description": "Referral program activity returned.", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/programs/{id}/get-referee-incentive": { "get": { "x-handler": "referral_programs/referral_program_controller.js", "x-access": [ "anonymous", "influencer" ], "operationId": "getReferralProgramIncentiveForReferee", "description": "Get the incentive that a referee unlocks for a given referral program", "parameters": [ { "name": "id", "in": "path", "required": true, "type": "string" }, { "name": "membershipId", "in": "query", "required": true, "type": "string" } ], "responses": { "200": { "description": "Incentive the referee just won", "schema": { "type": "object", "properties": { "incentive": { "type": "object", "properties": { "promocode": { "type": "string" }, "incentiveTitle": { "type": "string" }, "type": { "type": "string" } } }, "referringMemberDetails": { "type": "object", "properties": { "firstName": { "type": "string" }, "profilePhotoUrl": { "type": "string" } } } } } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/programs/referral-program": { "get": { "tags": [ "Program" ], "x-handler": "referral_programs/referral_program_controller.js", "x-access": [ "administrator", "influencer" ], "operationId": "getReferralProgram", "description": "Get the referral program for a given community, including the program's incentives", "responses": { "200": { "description": "Referral Program for a given community", "schema": { "type": "object", "properties": { "referralProgram": { "type": "object", "properties": { "name": { "type": "string" }, "sharingDescription": { "type": "string" }, "referrerIncentive": { "type": "object", "properties": { "incentiveTitle": { "type": "string" }, "id": { "type": "integer" } } }, "refereeIncentive": { "type": "object", "properties": { "incentiveTitle": { "type": "string" }, "id": { "type": "integer" } } } } } } } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/reports": { "get": { "tags": [ "Reports" ], "operationId": "getReport", "x-handler": "reports/reports_controller.js", "x-access": [ "administrator", "shared-cipher" ], "x-sharedCipherParameters": { "actionGroupId": "campaignId" }, "summary": "Retrieve a report", "parameters": [ { "name": "reportName", "in": "query", "type": "string", "required": false }, { "name": "fromDate", "in": "query", "type": "string", "required": false }, { "name": "toDate", "in": "query", "type": "string", "required": false }, { "name": "campaignId", "in": "query", "type": "array", "items": { "type": "integer" }, "required": false }, { "name": "reportingGroupId", "in": "query", "type": "string", "required": false }, { "name": "groupBy", "in": "query", "type": "string", "required": false }, { "name": "communityIds", "in": "query", "type": "array", "items": { "type": "string" }, "required": false }, { "name": "networks", "in": "query", "type": "array", "items": { "type": "string" }, "required": false } ], "responses": { "200": { "description": "A collection of report data", "schema": { "properties": { "data": { "type": "object", "additionalProperties": {} } } } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Resource not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-member-reward-wins/{listMemberRewardWinId}": { "get": { "tags": [ "ListMemberRewardWin" ], "operationId": "getListMemberRewardWin", "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Gets a list member reward win.", "parameters": [ { "name": "listMemberRewardWinId", "in": "path", "description": "ID of list member reward win", "required": true, "type": "integer" } ], "responses": { "200": { "description": "An individual list member reward win", "schema": { "$ref": "#/definitions/ListMemberRewardWin" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } }, "put": { "tags": [ "ListMemberRewardWin" ], "operationId": "updateRewardWin", "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Update the List Member Reward Win.", "parameters": [ { "name": "listMemberRewardWinId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberRewardWin" } } ], "responses": { "200": { "description": "List Member Reward Win updated successfully.", "schema": { "$ref": "#/definitions/ListMemberRewardWin" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Message not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-member-reward-win/bulk-fulfill/options/reward-wins": { "post": { "tags": [ "ListMemberRewardWin" ], "operationId": "getRewardWinsForBulkFulfillment", "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Get all reward wins for bulk fulfillment confirmation based on option selection", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "actionGroupId" ], "properties": { "paymentAccountId": { "type": "integer" }, "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "actionGroupId": { "type": "integer" }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "An array of reward wins bulk fulfillment based on the selected option.", "schema": { "type": "object", "properties": { "meta": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "totalCount": { "type": "integer" }, "paymentAccountType": { "type": "string" }, "paymentAccountBalance": { "type": "number" }, "paymentAccountProvider": { "type": "string" }, "paymentAccountId": { "type": "number" } } }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "value": { "type": [ "number", "null" ] }, "cost": { "type": [ "number", "null" ] }, "valueCurrencyCode": { "type": "string" }, "costCurrencyCode": { "type": "string" }, "bonusTierCurrencyCode": { "type": [ "string", "null" ] }, "bonusTiers": { "type": [ "array", "null" ], "items": { "$ref": "#/definitions/BonusTier" } }, "attainedBonusTierIndex": { "type": [ "integer", "null" ] }, "type": { "type": "string" }, "displayType": { "type": "string" }, "rewardTitle": { "type": "string" }, "displayName": { "type": "string" }, "isSelected": { "type": "boolean" }, "globalUserId": { "type": "number" }, "listMemberId": { "type": "number" }, "discountCodeId": { "type": "string" }, "incentiveId": { "type": "number" }, "taxLineItems": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "type": { "type": "string" }, "amount": { "type": "number" } } } } } } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-member-reward-win/bulk-fulfill/options": { "post": { "tags": [ "ListMemberRewardWin" ], "operationId": "getBulkFulfillOptions", "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Get all bulk fulfillment options for a selection of influencers, combine all offline options into one option", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "actionGroupId" ], "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "actionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup" }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "An array of options for bulk fulfillment.", "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/BulkFulfillOption" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-member-reward-win/bulk-fulfill/options-all": { "post": { "tags": [ "ListMemberRewardWin" ], "operationId": "getAllBulkFulfillOptions", "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Get all bulk fulfillment options for a selection of influencers, splitting all offline options into their own options", "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "actionGroupId" ], "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "actionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup" }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "An array of options for bulk fulfillment.", "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/BulkFulfillOption" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/list-member-reward-wins/enriched": { "get": { "tags": [ "ListMemberRewardWin" ], "x-handler": "reward_wins/list_member_reward_win/list_member_reward_win_controller.js", "x-access": [ "administrator" ], "summary": "Get enriched list member reward win data by incentive ids. Expects comma-separated string representations of an array of integers.", "operationId": "getEnrichedListMemberRewardWins", "parameters": [ { "name": "rewardWinIds", "in": "query", "type": "string", "required": false }, { "name": "cashPaymentIds", "in": "query", "type": "string" } ], "responses": { "200": { "description": "An array of list members with their list member reward wins", "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/EnrichedListMemberRewardWin" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/global-users/{globalUserId}/audience-cities": { "get": { "summary": "Retrieve cities of the user's audience.", "tags": [ "GlobalUserAudience" ], "operationId": "getGlobalUserAudienceCities", "x-access": [ "administrator", "shared-cipher" ], "x-handler": "users/global_user_audience_city_controller.js", "parameters": [ { "name": "globalUserId", "in": "path", "required": true, "type": "integer" }, { "$ref": "#/parameters/limitParam" }, { "$ref": "#/parameters/offsetParam" }, { "name": "orderProperty", "in": "query", "type": "string", "enum": [ "city", "percentage" ] }, { "$ref": "#/parameters/orderDirection" } ], "responses": { "200": { "description": "Collection of cities", "schema": { "type": "object", "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "type": "array", "items": { "type": "object", "properties": { "city": { "type": "string" }, "percentage": { "type": "number" } } } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/{actionGroupId}/workflow-performance-forecast": { "get": { "tags": [ "Workflow" ], "operationId": "getWorkflowActionGroupPerformanceForecast", "x-handler": "workflow/workflow_action_group_forecast_controller.js", "x-access": [ "administrator", "root" ], "summary": "Retrieve performance forecast for an action group.", "parameters": [ { "name": "actionGroupId", "in": "path", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Workflow Performance forecast.", "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "candidates": { "$ref": "#/definitions/WorkflowActionGroupPerformanceForecast" }, "participants": { "$ref": "#/definitions/WorkflowActionGroupPerformanceForecast" }, "complete": { "$ref": "#/definitions/WorkflowActionGroupPerformanceForecast" }, "forecast": { "$ref": "#/definitions/WorkflowActionGroupPerformanceForecast" } } } } } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/promote-initial": { "post": { "x-handler": "workflow/workflow_controller.js", "summary": "Promote global userIds to list members and set their status to the initial workflow stage", "x-access": [ "administrator" ], "operationId": "promoteToInitialWorkflowStage", "tags": [ "Workflow" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": [ "string", "integer" ] } }, "actionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup" }, "fromActionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup which you are promoting from." }, "queryFilter": { "type": "object", "description": "Filter for the query." }, "searchState": { "type": "object", "description": "Capture Search State for analytics" }, "useSearchWithOpenAI": { "type": "boolean", "description": "Flag to detect if search was done with OpenAI" }, "openAISearchResults": { "type": "string", "description": "OpenAI Search Results JSON" } } } } ], "responses": { "200": { "description": "Initial workflow stage with Conversation Templates", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/{listMemberId}/promote": { "put": { "x-handler": "workflow/workflow_controller.js", "summary": "Promote a List Member to their next status.", "x-access": [ "administrator" ], "operationId": "promoteListMember", "tags": [ "Workflow" ], "parameters": [ { "name": "listMemberId", "in": "path", "type": "integer", "required": true }, { "name": "data", "in": "body", "required": false, "schema": { "type": "object", "properties": { "currentCustomStatusId": { "type": "integer" } } } } ], "responses": { "200": { "description": "Successfully added globalUserIds to list and moved to first workflow stage", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "412": { "description": "Invalid custom status id.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/{activityId}/get-initial-status-automation-rules": { "get": { "x-handler": "workflow/workflow_controller.js", "summary": "Get intial workflow status with automation rules", "x-access": [ "administrator" ], "operationId": "getInitialWorkflowStatusAutomationRules", "tags": [ "Workflow" ], "parameters": [ { "name": "activityId", "in": "path", "type": "integer", "required": true }, { "name": "expectedNumberOfInfluencers", "in": "query", "type": "integer", "required": false } ], "responses": { "200": { "description": "Initial workflow status with automation rules", "schema": { "type": "object", "items": { "$ref": "#/definitions/ListCustomStatusDeprecated" } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/bulk-promote": { "put": { "x-handler": "workflow/workflow_controller.js", "summary": "Promote many List Members to their next status.", "x-access": [ "administrator" ], "operationId": "bulkPromote", "tags": [ "Workflow" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "actionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup" }, "currentStageSlug": { "type": "string", "description": "The stage that we are promoting from." }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Successfully added globalUserIds to list and moved to first workflow stage", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/{listMemberId}/drop": { "put": { "x-handler": "workflow/workflow_controller.js", "summary": "Drop a List Member.", "x-access": [ "administrator" ], "operationId": "dropListMember", "tags": [ "Workflow" ], "parameters": [ { "name": "listMemberId", "in": "path", "type": "integer", "required": true } ], "responses": { "200": { "description": "Successfully added globalUserIds to list and moved to first workflow stage", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/bulk-drop": { "put": { "x-handler": "workflow/workflow_controller.js", "summary": "Drop many List Members.", "x-access": [ "administrator" ], "operationId": "bulkDrop", "tags": [ "Workflow" ], "parameters": [ { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "globalUserIds": { "type": "array", "items": { "type": "integer" } }, "actionGroupId": { "type": "integer", "description": "Unique identifier of the actionGroup" }, "queryFilter": { "$ref": "#/definitions/ActionGroupCandidateQueryFilter" } } } } ], "responses": { "200": { "description": "Successfully added globalUserIds to list and moved to first workflow stage", "schema": { "$ref": "#/definitions/EmptyObject" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/workflow/{id}/status-summary": { "get": { "x-handler": "workflow/workflow_status_summary_controller.js", "summary": "Retrieve workflow status summary.", "x-access": [ "administrator" ], "tags": [ "Workflow" ], "operationId": "getWorkflowStatusSummary", "parameters": [ { "name": "id", "in": "path", "description": "ID of Worklfow/List", "required": true, "type": "integer" } ], "responses": { "200": { "description": "Summary of workflow statuses and counts of influencers.", "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStatusSummary" } } } } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/action-groups/{id}/workflow-status-summary": { "get": { "x-handler": "workflow/workflow_status_buckets/workflow_status_buckets_controller.js", "summary": "Retrieve a summary of list member counts through the workflow stages.", "x-access": [ "administrator" ], "operationId": "getWorkflowStatusBuckets", "tags": [ "ActionGroups" ], "parameters": [ { "name": "id", "in": "path", "description": "ID of action group", "required": true, "type": "integer" } ], "responses": { "200": { "description": "A Summary of list members in the workflow of this campaign.", "schema": { "$ref": "#/definitions/WorkflowStatusBuckets" } }, "400": { "description": "Invalid parameter.", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Session expired.", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Action group not found.", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/Error" } }, "default": { "description": "Unexpected error", "schema": { "$ref": "#/definitions/Error" } } } } }, "/v1/global-users/me": { "get": { "operationId": "retrieveCurrentUser", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RetrieveCurrentUserResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [] } }, "/v1/global-users/{id}": { "get": { "operationId": "get", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetGlobalUserResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "index", "required": false, "type": "string", "enum": [ "user_index", "members_index" ] }, { "in": "query", "name": "isPublic", "required": false, "type": "boolean" } ] }, "put": { "operationId": "updateGlobalUserSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Update an Influencer Index creator's contact info.", "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGlobalUserBodyDefinition" } } ] } }, "/v1/global-users": { "get": { "operationId": "getGlobalUsers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetGlobalUsersResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Unprocessable Content, Invalid Query Parameters", "schema": { "$ref": "#/definitions/UnprocessableContent" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "This endpoint point is also used by other microservices ike export-service\nretrieveIds is a boolean, see https://github.com/latermedia/export-service/blob/0bf2bf7ab022e718697872cd9de5a6fe05aab2fb/worker/src/main/kotlin/co/mavrck/exportservice/worker/Sapi.kt#L71\nglobalUserIds in queryParams is a string: \"3704000,13704570,13704663\", but it's used as an array of number in the code", "tags": [ "GlobalUser" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "useSearchWithOpenAI", "required": false, "type": "boolean" }, { "in": "query", "name": "retrieveIds", "required": false, "type": "boolean" }, { "in": "query", "name": "globalUserIds", "required": false, "type": "string" }, { "in": "query", "name": "prompt", "required": false, "type": "string" } ] }, "put": { "operationId": "addNewInfluencer", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "action": { "$ref": "#/definitions/GlobalUserUpsertAction" }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "action", "globalUserId" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Add a new creator using CDS-first lookup.\nReturns the global user ID and action (CREATED or CONFLICT) if the creator was added successfully.\nReturns an error if the creator could not be added.", "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGlobalUserBodyDefinition" } } ] } }, "/v1/global-users/preview": { "put": { "operationId": "previewAddCreator", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "movingTo": { "type": "string", "enum": [ "index", "members", "both" ], "x-nullable": false }, "message": { "type": "string" }, "preview": { "type": "boolean" }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true }, "action": { "$ref": "#/definitions/GlobalUserUpsertAction" } }, "required": [ "preview", "globalUserId", "action" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Preview CDS-first creator lookup without side effects.\nReturns what action would be taken if the creator were to be added.", "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateGlobalUserBodyDefinition" } } ] } }, "/v1/global-users/{globalUserId}/audience-demographics/latest": { "post": { "operationId": "refreshAudienceDemographics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": true } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/RefreshAudienceDemographicsBody" } } ] } }, "/v1/global-users/{globalUserId}/audience-demographics": { "get": { "operationId": "getAudienceDemographics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserAudienceDemographicsResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/public-users": { "post": { "operationId": "markPublic", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] }, "delete": { "operationId": "markPrivate", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/creator-refresh": { "post": { "operationId": "enqueueCreatorRefresh", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "previewPostsLastUpdatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "recentlyAnalyzed": { "type": "boolean" }, "lastRefreshedAt": { "type": "string", "format": "date-time", "x-nullable": true } }, "required": [ "previewPostsLastUpdatedAt", "recentlyAnalyzed", "lastRefreshedAt" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/brand-safety-request": { "post": { "operationId": "makeBrandSafetyRequest", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BrandSafetyRequestReponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/brand-suitability": { "get": { "operationId": "getBrandSuitabilityReport", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBrandSuitabilityReportResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "campaignId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "brandName", "required": false, "type": "string" } ] }, "post": { "operationId": "generateBrandSuitabilityReport", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GenerateBrandSuitabilityReportResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GenerateBrandSuitabilityReportRequest" } } ] } }, "/v1/global-users/all-social-profiles": { "post": { "operationId": "getAllSocialProfiles", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserSearchAllSocialProfilesByIdsPostResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GlobalUserSearchAllSocialProfilesByIdsPostParams" } } ] } }, "/v1/global-users/inconsistencies": { "post": { "operationId": "getInconsistencies", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserGetInconsistenciesPostResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GlobalUserGetInconsistenciesPostParams" } } ] } }, "/v1/global-users/repair": { "post": { "operationId": "repair", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserRepairPostResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GlobalUserRepairPostParams" } } ] } }, "/v1/global-users/random/guids": { "get": { "operationId": "getRandomGlobalUsers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserGetRandomGlobalUsersResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/mark-as-non-contactable": { "post": { "operationId": "markAsNonContactable", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing or invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/delete-public-summary-record": { "post": { "operationId": "deletePublicSummaryRecord", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing or invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/{globalUserId}/audience-countries": { "get": { "operationId": "getGlobalUserAudienceCountries", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserAudienceCountriesQueryResult" } }, "400": { "description": "Missing or invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Global user not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, { "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "percentage", "country" ] }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" } ] } }, "/v1/global-users/import-influencers": { "post": { "operationId": "importInfluencers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing or invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ImportInfluencerBody" } } ] } }, "/v1/global-users/{globalUserId}/content": { "post": { "operationId": "fetchContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/ContentPost" }, "type": "array" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "deprecated": true, "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "socialNetwork", "required": true, "type": "string" }, { "in": "query", "name": "discover", "required": false, "type": "boolean" } ] } }, "/v1/global-users/{globalUserId}/reindex": { "post": { "operationId": "reindexUser", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/global-users/bulk-actions": { "post": { "operationId": "bulkActions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "message": { "type": "string" }, "result": { "additionalProperties": true }, "action": { "type": "string", "enum": [ "reindex", "refreshAudienceDemographics" ], "x-nullable": false } }, "required": [ "result", "action" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUser" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BulkActionsBody" } } ] } }, "/v1/my-account": { "get": { "operationId": "getCurrentAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CurrentAdministratorAccount" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "UserAccount" ], "parameters": [] }, "put": { "operationId": "updateCurrentAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "UserAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AdministratorAccountPutBody" } } ] } }, "/v1/user-account": { "post": { "operationId": "createUserAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "UserAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AdministratorAccountPostBody" } } ] } }, "/v1/social-accounts": { "get": { "operationId": "getInfluencerSocialAccounts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GlobalUserSocialAccountsResponse" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "UserAccount" ], "parameters": [ { "in": "query", "name": "globalUserId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/activation-tags": { "post": { "operationId": "createTag", "produces": [ "application/json" ], "responses": { "200": { "description": "Tag created", "schema": { "$ref": "#/definitions/ActivationTagPostResponse" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActivationTags" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActivationTagPostRequestBody" } } ] }, "get": { "operationId": "getTags", "produces": [ "application/json" ], "responses": { "200": { "description": "Tags retrieved successfully", "schema": { "$ref": "#/definitions/ActivationTagsGetResponse" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActivationTags" ], "parameters": [ { "in": "query", "name": "query", "required": false, "type": "string" }, { "default": 15, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/activation-tags/{name}": { "delete": { "operationId": "deleteTag", "produces": [ "application/json" ], "responses": { "200": { "description": "Tag deleted successfully" }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActivationTags" ], "parameters": [ { "in": "path", "name": "name", "required": true, "type": "string" } ] } }, "/v1/export/start-async": { "post": { "operationId": "startAsync", "produces": [ "application/json" ], "responses": { "200": { "description": "Asynchronous export accepted" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Exports" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ExportBody" } } ] } }, "/v1/export/activations-content": { "post": { "operationId": "exportActivationContent", "produces": [ "application/json" ], "responses": { "200": { "description": "The archive is created and is being downloaded" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Exports" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ContentExportBody" } } ] } }, "/v1/export/content": { "post": { "operationId": "exportContent", "produces": [ "application/json" ], "responses": { "200": { "description": "The archive is created and is being downloaded" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "429": { "description": "Priority export slot is busy" }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Exports" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ContentExportBody" } } ] } }, "/v1/export/download": { "get": { "operationId": "downloadExportContent", "produces": [ "application/json" ], "responses": { "302": { "description": "Redirect to a short-lived download URL" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Exports" ], "parameters": [ { "in": "query", "name": "token", "required": true, "type": "string" } ] } }, "/v1/campaign-performance/audience-insights": { "get": { "operationId": "getAudienceInsights", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CampaignAudienceInsights" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignPerformance" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "communityId", "required": false, "type": "string" } ], "x-sharedCipherParameters": { "actionGroupId": "actionGroupId" } } }, "/v1/campaign-performance/audience-insights/aggregate": { "get": { "operationId": "getAggregatedAudienceInsights", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CampaignAudienceInsights" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Returns aggregated audience insights across multiple campaigns.\nWhen actionGroupIds are provided, aggregates data for those specific campaigns.\nWhen actionGroupIds are omitted, aggregates data for all campaigns belonging to the given communityId.\nFilter by date range using the required startDate and endDate (based on post date).", "tags": [ "CampaignPerformance" ], "parameters": [ { "in": "query", "name": "communityId", "required": true, "type": "string" }, { "in": "query", "name": "startDate", "required": true, "format": "date-time", "type": "string" }, { "in": "query", "name": "endDate", "required": true, "format": "date-time", "type": "string" }, { "in": "query", "name": "actionGroupIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/draft-content": { "post": { "operationId": "createDraftContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerDraftContentDto" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "body", "name": "draftContentData", "required": true, "schema": { "$ref": "#/definitions/AdminDraftContentPostBody" } } ] } }, "/v1/draft-content/{draftContentId}": { "put": { "operationId": "updateDraftContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/DraftContentUpdateBody" } } ] }, "delete": { "operationId": "archiveDraftContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/draft-content/{draftContentId}/status": { "put": { "operationId": "updateDraftContentStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/DraftContentStatusUpdateBody" } } ] } }, "/v1/draft-content/{draftContentId}/feedback": { "put": { "operationId": "updateDraftContentFeedback", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/draftContentFeedbackUpdateBody" } } ] }, "get": { "operationId": "getDraftContentFeedback", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ResponseBody_DraftContentFeedbackEntry-Array_" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/influencer-polling": { "post": { "operationId": "addInfluencerPollingMessages", "produces": [ "application/json" ], "responses": { "200": { "description": "Added pending activations to the queue" }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Influencer Polling" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InfluencerPollingRequestBody" } } ] } }, "/v1/action-groups/{actionGroupId}/review-form-responses": { "get": { "operationId": "getReviewFormResponses", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ReviewFormResponse-Array_" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Review Responses not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ReviewFormResponses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "ratingsFilter", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "reviewCharacterCountFilter", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "products", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" } ] } }, "/v1/review-form-responses": { "get": { "operationId": "getInstanceLevelReviews", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ReviewFormResponse-Array_" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Review Responses not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ReviewFormResponses" ], "parameters": [ { "in": "query", "name": "ratingsFilter", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "reviewCharacterCountFilter", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "products", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" } ] } }, "/v1/instance-user-materialized-view": { "put": { "operationId": "Put", "produces": [ "application/json" ], "responses": { "201": { "description": "created" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InstanceUserMaterializedViewRequestBody" } } ] } }, "/v1/actions/{actionId}/self-reported-activations": { "post": { "operationId": "selfReportActivation", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActivationResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Activations" ], "parameters": [ { "in": "path", "name": "actionId", "required": true, "type": "string" }, { "in": "body", "name": "data", "required": false, "schema": { "$ref": "#/definitions/LegacySelfReportedActivationBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns": { "get": { "operationId": "getCampaigns", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/LaterInfluencerCampaignListDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "query", "name": "status", "required": true, "type": "string" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "default": 20, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "communityIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}": { "get": { "operationId": "getCampaign", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/LaterInfluencerCampaignDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/ytbc-campaign-code": { "get": { "operationId": "getYtbcCampaignCode", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerYtbcCampaignCodeResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/members": { "put": { "operationId": "updateCampaignMembership", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateCampaignMembershipPutBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/decline-invitation": { "post": { "operationId": "declineCampaignInvitation", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/drafts": { "get": { "operationId": "getDrafts", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerDraftContentGetResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "threadId", "required": false, "type": "string" } ] }, "post": { "operationId": "submitDraft", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerDraftContentDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InfluencerDraftContentPostBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/drafts/{draftId}": { "delete": { "operationId": "deleteDraft", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "draftId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/concepts": { "get": { "operationId": "getConcepts", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerConceptContentGetResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "threadId", "required": false, "type": "string" } ] }, "post": { "operationId": "submitConcept", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerConceptContentDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InfluencerConceptContentPostBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/concepts/{conceptId}": { "delete": { "operationId": "deleteConcept", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "conceptId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/application-answers": { "get": { "operationId": "getApplicationAnswers", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/LaterInfluencersDataPointDto" }, "type": "array" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "setApplicationAnswers", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "responses", "required": true, "schema": { "$ref": "#/definitions/MembershipDataPointResponses" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/payment-recipient": { "post": { "operationId": "upsertPaymentRecipient", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberPaymentRecipientResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberPaymentRecipientUpsertRequest" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/file-upload-policies": { "post": { "operationId": "createFileUploadPolicy", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/SigningData" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/FileUploadPoliciesPostBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/url-metadata": { "get": { "operationId": "getURLMetadata", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "query", "name": "url", "required": true, "type": "string" }, { "in": "query", "name": "s3Upload", "required": false, "type": "boolean" }, { "in": "query", "name": "s3Directory", "required": false, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/networks": { "get": { "operationId": "getNetworks", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "additionalProperties": true } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/content": { "post": { "operationId": "submitContent", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActivationResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": false, "schema": { "$ref": "#/definitions/SelfReportedActivationBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/content-preview": { "get": { "operationId": "getContentPreview", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/PreviewPost" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/products": { "get": { "operationId": "getReviewableProducts", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/LaterInfluencerProductPageDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "searchTerm", "required": false, "type": "string" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/auth/email": { "post": { "operationId": "authenticateEmail", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/AuthResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AuthEmailRequestBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/auth/facebook": { "post": { "operationId": "authenticateFacebook", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/AuthResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AuthFacebookRequestBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/oauth/tiktok": { "post": { "operationId": "registerTikTokCreator", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Components.Schemas.Creator" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/LaterInfluencerTikTokAuthBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/tiktok-invite-links": { "get": { "operationId": "getTikTokInviteLink", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Pick_Components.Schemas.InviteLinkResponse.campaignId-or-handleName-or-inviteLinkExpiresAt-or-inviteLink_" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] }, "post": { "operationId": "createTikTokInviteLink", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Pick_Components.Schemas.InviteLinkResponse.campaignId-or-handleName-or-inviteLinkExpiresAt-or-inviteLink_" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/products/{productId}/reviews": { "get": { "operationId": "getProductReviews", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/LaterInfluencerProductReviewDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "productId", "required": true, "format": "double", "type": "number" } ] }, "post": { "operationId": "submitProductReview", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/LaterInfluencerProductReviewDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "productId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ProductReviewsPostBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/settings": { "get": { "operationId": "getSettings", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerSettings" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" } ] }, "put": { "operationId": "updateSettings", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerSettings" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "body", "name": "settings", "required": true, "schema": { "$ref": "#/definitions/InfluencerSettingsPayload" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}": { "get": { "operationId": "exportData", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ExportResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "query", "name": "isExport", "required": true, "type": "boolean" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/payment-providers/stripe/onboarding-link": { "get": { "operationId": "getStripeOnboardingLink", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/StripeOnboardingLink" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "query", "name": "redirectUrl", "required": true, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/payment-providers/stripe/dashboard-link": { "get": { "operationId": "getStripeDashboardLink", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/StripeDashboardLink" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/payment-providers/stripe/accounts": { "get": { "operationId": "getStripeAccounts", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/StripeAccount" }, "type": "array" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" } ] }, "delete": { "operationId": "deleteStripeConnectedAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "deleteStripeConnectedAccount\nIf a Stripe account is connected and has no transactions, delete the account.\nParts of the UI expect a stripe account to exist, so if the account is deleted, create a new one,\nwhich allows users to re-do stripe onboarding.", "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "query", "name": "country", "required": false, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/brands": { "get": { "operationId": "getBrands", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/GetInfluencerBrandsResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/influencer-statuses": { "get": { "operationId": "getInfluencerStatuses", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/InfluencerStatusListDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/influencer-status-reports": { "post": { "operationId": "setInfluencerStatus", "produces": [ "application/json" ], "responses": { "201": { "description": "Created" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ReportInfluencerStatusRequestBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/connections": { "put": { "operationId": "connectExternalPlatform", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "connection": { "$ref": "#/definitions/Record_ExternalPlatform.boolean_" } }, "required": [ "connection" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/ConflictError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ExternalPlatformConnection" } } ] }, "get": { "operationId": "getExternalPlatformConnections", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "connections": { "$ref": "#/definitions/ExternalPlatformConnectionMap" } }, "required": [ "connections" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{campaignId}/links": { "get": { "operationId": "getLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaterInfluencerLinks" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/surveys/{surveyId}": { "get": { "operationId": "getSurvey", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LaterInfluencerSurveyDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "surveyId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/surveys/{surveyId}/answers": { "post": { "operationId": "submitSurveyAnswers", "produces": [ "application/json" ], "responses": { "200": { "description": "Created" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "surveyId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/QuestionAnswers" } } ] } }, "/v1/action-groups/{actionGroupId}/conversation-templates": { "post": { "operationId": "createActionGroupConversationTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActionGroupConversationTemplatePostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupConversationTemplatePostBody" } } ] }, "get": { "operationId": "getActionGroupConversationTemplates", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActionGroupConversationTemplatesGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] }, "delete": { "operationId": "resetActionGroupConversationTemplates", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{actionGroupId}/conversation-templates/{id}/copy": { "post": { "operationId": "copyActionGroupConversationTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActionGroupConversationTemplateCopyPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupConversationTemplateCopyPostBody" } } ] } }, "/v1/action-groups/{actionGroupId}/conversation-templates/{id}": { "delete": { "operationId": "deleteActionGroupConversationTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": {} }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateActionGroupConversationTemplate", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupConversationTemplatePutBody" } } ] } }, "/v1/action-groups/{actionGroupId}/conversation-templates/reorder": { "post": { "operationId": "reorderActionGroupConversationTemplates", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ActionGroupConversationTemplateReorderPutResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupConversationTemplates" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupConversationTemplateReorderPutBody" } } ] } }, "/v1/action-groups/{id}/subscriber-settings": { "get": { "operationId": "getSubscriberSettings", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SubscriberSettings" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroups" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{actionGroupId}/participants": { "get": { "operationId": "getActionGroupParticipants", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/QueryActionGroupParticipantsResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/Framework.BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/Framework.ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/Framework.NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/Framework.ServerError" } } }, "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "customStatusId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "listMemberId", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "includeCommentsCount", "required": false, "type": "boolean" }, { "in": "query", "name": "includePinnedComment", "required": false, "type": "boolean" }, { "in": "query", "name": "includeInstagramPosts", "required": false, "type": "boolean" }, { "in": "query", "name": "includeTiktokPosts", "required": false, "type": "boolean" }, { "in": "query", "name": "postCount", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderProperty", "required": false, "type": "string" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "desc", "asc", "DESC", "ASC" ] }, { "in": "query", "name": "q", "required": false, "type": "string" } ] } }, "/v1/action-groups/{actionGroupId}/template-update-cta": { "post": { "operationId": "hideTemplateUpdateCTA", "produces": [ "application/json" ], "responses": { "200": { "description": "Template update CTA disabled" }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Actions" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{actionGroupId}/review-forms": { "put": { "operationId": "upsertReviewForm", "produces": [ "application/json" ], "responses": { "200": { "description": "Review form updated successfully", "schema": { "$ref": "#/definitions/ReviewForm" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Review form tied to action not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ReviewForm" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/UpsertReviewFormBody" } } ] } }, "/v1/action/{id}/review-form": { "get": { "operationId": "getReviewFormByActionId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReviewForm" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Review form tied to action not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Reviews" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ] } }, "/v1/action-teasers/{id}": { "get": { "operationId": "getActionTeaserById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetActionTeaserResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Actions" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ] } }, "/v1/action-groups/{id}/updateBrief": { "post": { "operationId": "postNewVersion", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupBrief" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{id}/copies": { "post": { "operationId": "copyActionGroup", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupPostResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroups" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupCopyPostBody" } } ] } }, "/v1/action-groups/statuses": { "post": { "operationId": "getActionGroupStatuses", "produces": [ "application/json" ], "responses": { "200": { "description": "Action group statuses retrieved successfully", "schema": { "$ref": "#/definitions/ActionGroupStatusMap" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupsStatus" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupStatusQueryRequest" } } ] } }, "/v1/action-group-teaser/{id}": { "get": { "operationId": "getActionGroupTeaserById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupTeaserGetResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroups" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/activation-tags-associations": { "post": { "operationId": "associateTagsToActivations", "produces": [ "application/json" ], "responses": { "200": { "description": "Tag associated successfully", "schema": { "type": "string" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActivationTagsAssociations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActivationTagAssociationPostRequestBody" } } ] }, "delete": { "operationId": "disassociateTagsFromActivations", "produces": [ "application/json" ], "responses": { "200": { "description": "Tag disassociated succesfully", "schema": { "$ref": "#/definitions/ActivationTagDisassociationDeleteResponse" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActivationTagsAssociations" ], "parameters": [ { "in": "query", "name": "activationIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "tagIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/activation-tags-associations/{activationId}": { "get": { "operationId": "getTagsByActivationId", "produces": [ "application/json" ], "responses": { "200": { "description": "Tags retrieved successfully", "schema": { "items": { "$ref": "#/definitions/ActivationTagAssociation" }, "type": "array" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActivationTagsAssociations" ], "parameters": [ { "in": "path", "name": "activationId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{actionGroupId}/global-users/{globalUserId}/activations": { "post": { "operationId": "Post", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "type": "number", "format": "double" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PostActivationsRequestBody" } } ] } }, "/v1/activations/{activationId}/approveApprovalStatus": { "put": { "operationId": "approveApprovalStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Activation successfully approved.", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Cannot Approve an Activation that's already Rejected, set to pending first.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Activation not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Activations" ], "parameters": [ { "in": "path", "name": "activationId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/activations/{activationId}/unrejectApprovalStatus": { "put": { "operationId": "unrejectApprovalStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Activation successfully set back to pending.", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Cannot 'Unapprove' an Activation that's already approved.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Activation not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Activations" ], "parameters": [ { "in": "path", "name": "activationId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/activations/{activationId}/rejectApprovalStatus": { "put": { "operationId": "rejectApprovalStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Activation successfully rejected.", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Cannot reject an Activation that is approved.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Activation not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Activations" ], "parameters": [ { "in": "path", "name": "activationId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/activation/history": { "get": { "operationId": "getActivationHistory", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ActivationHistoryItem-Array_" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Activations" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "campaignId", "required": false, "type": "string" }, { "in": "query", "name": "actionId", "required": false, "type": "string" }, { "in": "query", "name": "audienceId", "required": false, "type": "string" }, { "in": "query", "name": "actionTitle", "required": false, "type": "string" }, { "in": "query", "name": "actionTypes", "required": false, "type": "string" }, { "in": "query", "name": "type", "required": false, "type": "string", "enum": [ "create", "amplify", "survey", "review", "follow", "view", "other" ] } ] } }, "/v1/reporting-details/influencer-incentive-info": { "get": { "operationId": "GetInfluencerIncentiveCosts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/InfluencerIncentiveDetailsResponse" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "rewardWinIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "listMemberIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "globalUserId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/reporting-details/campaign-details": { "get": { "operationId": "GetEnrichCampaignsData", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedCampaignsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "campaignId", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/reporting-details/creators-enrichment": { "get": { "operationId": "GetCreatorsEnrichment", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedCreatorsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "globalUserId", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/reporting-details/v2/creators-enrichment": { "get": { "operationId": "GetCreatorDetails", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedCreatorsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "globalUserId", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/reporting-details/v3/creators-enrichment": { "get": { "operationId": "getCreatorDetailsMultiCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedCreatorsResponseV3" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "globalUserIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/reporting-details/content-enrichment": { "get": { "operationId": "GetContentEnrichment", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedContentResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "activationId", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "communityId", "required": true, "type": "string" }, { "default": true, "in": "query", "name": "includeAdditionalCreatorProfileInfo", "required": false, "type": "boolean" } ] } }, "/v1/reporting-details/v2/content-enrichment": { "get": { "operationId": "GetContentEnrichmentV2", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EnrichedContentResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "activationIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "default": true, "in": "query", "name": "includeAdditionalCreatorProfileInfo", "required": false, "type": "boolean" } ] } }, "/v1/reporting-details/backfill": { "post": { "operationId": "backfillAnalyticsServiceData", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Analytics" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillAnalyticsDataEntryPointJobPayload" } } ] } }, "/v1/reporting-details/backfill-cost": { "post": { "operationId": "backfillAnalyticsServiceData", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Analytics" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillAnalyticsCostDataJobPayload" } } ] } }, "/v1/reporting-details/reviews": { "get": { "operationId": "GetCampaignReviews", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ContentReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Analytics" ], "parameters": [ { "in": "query", "name": "campaignId", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "default": "TOTAL", "in": "query", "name": "groupBy", "required": false, "type": "string" } ] } }, "/v1/backfill-analytics/followers-at-post": { "post": { "operationId": "backfillFollowersAtPost", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BackfillFollowersAtPostResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Backfill Analytics" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillFollowersAtPostRequest" } } ] } }, "/v1/backfill-analytics/update-content-activation-summary": { "post": { "operationId": "updateContentActivationSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UpdateContentActivationSummaryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Backfill Analytics" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateContentActivationSummaryRequest" } } ] } }, "/v1/action-groups/{actionGroupId}/application-flow": { "get": { "operationId": "getApplicationFlow", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ApplicationStates" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Application" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/api-key/login": { "post": { "operationId": "loginAdmin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BasicAuthPostResponse" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Authentication" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/BasicAuthPostRequest" } } ] } }, "/v1/auth/facebook/exchange-code-for-token": { "post": { "operationId": "exchangeCodeForToken", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "accessToken": { "type": "string" }, "token": { "type": "string" } }, "required": [ "accessToken", "token" ], "type": "object" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "exchangeCodeForToken\n\nExchange a Facebook access code for a token\nUsed as part of the connecting a social profile on the Community App\nFE requires a Facebook access token prior to connecting a social profile in order to fetch the available pages from the FB API\nBecause of how we are using satellizer on the FE to manage the OAuth flow,\nwe are required to return our own token as part of this response\nThis endpoint requires the user to be authenticated and returns the existing api key as the token", "tags": [ "Authentication" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/FacebookAccessCodeExchangeRequest" } } ] } }, "/v1/api-key/swap-app": { "post": { "operationId": "swapCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "Authorization info", "schema": { "$ref": "#/definitions/SwapAppPostResponse" } }, "400": { "description": "Missing or Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Authentication" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SwapAppRequestBody" } } ] } }, "/v1/pending-batch-jobs/{actionGroupId}": { "get": { "operationId": "getPendingBatchJobs", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/GetPendingBatchJobsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PendingBatchJobs" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "type", "required": true, "type": "string" } ] } }, "/v1/action-groups/{actionGroupId}/bulk-assign-custom-statuses-requirements": { "get": { "operationId": "getRequirements", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/BulkAssignCustomStatusesRequirementsResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BulkAssignCustomStatusesRequirements" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "expectedNumberOfInfluencers", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "currentCustomStatusId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "targetCustomStatusId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/bazaar-apps": { "get": { "operationId": "getBazaarApps", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/BazaarVoiceAppResponse" }, "type": "array" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BazaarVoice" ], "parameters": [] }, "post": { "operationId": "createBazaarApp", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/BazaarVoiceAppResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "BazaarVoice" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BazaarVoiceAppPostRequest" } } ] } }, "/v1/bazaar-apps/locales": { "get": { "operationId": "getBazaarAppLocales", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/BazaarVoiceLocaleResponse" }, "type": "array" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BazaarVoice" ], "parameters": [] } }, "/v1/blogs": { "get": { "operationId": "getBlogs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Blog" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Blogs" ], "parameters": [] }, "put": { "operationId": "updateBlogs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Blogs" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/Blog" } } ] } }, "/v1/blogs/{globalUserId}": { "put": { "operationId": "updateBlogForGlobalUser", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Blogs" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/Blog" } } ] } }, "/v1/brand-suitability/harness/global-users/{globalUserId}/creator-context": { "get": { "operationId": "harnessCreatorContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Builds a structured creator profile from platform data (social handles, bio, location, etc.) *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] }, "post": { "operationId": "harnessSaveCreatorContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Builds (or accepts inline) creator context and persists it to DynamoDB, returning the stored record. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SaveCreatorContextRequest" } } ] } }, "/v1/brand-suitability/harness/global-users/{globalUserId}/creator-context/stored": { "get": { "operationId": "harnessGetStoredCreatorContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Reads the stored creator context record from DynamoDB. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] }, "patch": { "operationId": "harnessUpdateCreatorContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Partial-updates the stored creator context fields. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateCreatorContextRequest" } } ] }, "delete": { "operationId": "harnessDeleteCreatorContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Deletes the stored creator context record. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/brand-suitability/harness/brand-context": { "get": { "operationId": "harnessBrandContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "query", "name": "communityId", "required": false, "type": "string" } ] }, "post": { "operationId": "harnessSaveBrandContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Builds (or accepts inline) brand context and persists it to DynamoDB, returning the stored record. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SaveBrandContextRequest" } }, { "in": "query", "name": "communityId", "required": false, "type": "string" } ] } }, "/v1/brand-suitability/harness/brand-context/stored": { "get": { "operationId": "harnessGetStoredBrandContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Reads the stored brand context record from DynamoDB. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "query", "name": "communityId", "required": false, "type": "string" } ] }, "patch": { "operationId": "harnessUpdateBrandContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Partial-updates the stored brand context fields. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateBrandContextRequest" } }, { "in": "query", "name": "communityId", "required": false, "type": "string" } ] }, "delete": { "operationId": "harnessDeleteBrandContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Deletes the stored brand context record. *", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "query", "name": "communityId", "required": false, "type": "string" } ] } }, "/v1/brand-suitability/harness/campaigns/{campaignId}/campaign-context": { "get": { "operationId": "harnessCampaignContext", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/brand-suitability/harness/research": { "post": { "operationId": "harnessResearch", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Runs the research pipeline: discovery (search) + enrichment (visit each URL for full page content).\nProvide creatorContext directly (e.g. from prod) to skip the buildCreatorContext step,\nor provide globalUserId to build it from local data. One of the two is required.", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ResearchRequest" } } ] } }, "/v1/brand-suitability/harness/verify-sources": { "post": { "operationId": "harnessVerifySources", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Runs source verification against user-provided sources without running discovery.\nProvide creatorContext directly (e.g. from prod) to skip the buildCreatorContext step,\nor provide globalUserId to build it from local data. One of the two is required.", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/VerifySourcesRequest" } } ] } }, "/v1/brand-suitability/harness/global-users/{globalUserId}/reverify": { "post": { "operationId": "harnessReverify", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Re-runs verification on existing research from DynamoDB. Skips discovery.\nLoads stored findings and runs pre-filter + LLM verification.\nProvide creatorContext to skip buildCreatorContext, or omit to build from local data.", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ReverifyRequest" } } ] } }, "/v1/brand-suitability/harness/assess": { "post": { "operationId": "harnessAssessMetric", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AssessMetricRequest" } } ] } }, "/v1/brand-suitability/harness/assess-full": { "post": { "operationId": "harnessAssessFull", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/HarnessResponse_any.any_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Runs the full assessment pipeline (exec) on stored or inline findings without persisting the report.\nBuilds missing contexts from local data; inline overrides take precedence. One of creatorContext or globalUserId required.", "tags": [ "BrandSuitabilityHarness" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AssessFullRequest" } } ] } }, "/v1/brand-suitability/global-users": { "get": { "operationId": "getCreatorsWithReports", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCreatorsWithReportsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: unused for now -- TODO for admin view. *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/reports/{reportId}": { "get": { "operationId": "getReportById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBrandSuitabilityReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Lightbox (polling during generation), Admin DetailView *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "reportId", "required": true, "type": "string" } ] }, "delete": { "operationId": "deleteReport", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DeleteReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "reportId", "required": true, "type": "string" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/report": { "get": { "operationId": "getLatestReport", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetBrandSuitabilityReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Lightbox reports", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "campaignId", "required": false, "type": "string" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/reports": { "get": { "operationId": "getReportsForCreator", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetReportsForCreatorResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Admin — DetailView, ReportsSelector *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "campaignId", "required": false, "type": "string" } ] }, "post": { "operationId": "generateReport", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/GenerateReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Frontend: Lightbox — generate + refresh buttons, Admin DetailView *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GenerateReportRequest" } } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/reports/sync": { "post": { "operationId": "generateReportSync", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/GenerateReportResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Frontend: Admin — DetailView *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/GenerateReportRequest" } } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/research/refresh": { "put": { "operationId": "refreshCreatorResearch", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreatorResearchRecord" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: unused (async version) *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "brandName", "required": false, "type": "string" }, { "in": "query", "name": "force", "required": false, "type": "boolean" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/research/refresh/sync": { "put": { "operationId": "refreshCreatorResearchSync", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CreatorResearchRecord" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Admin — DetailView, TableView *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "brandName", "required": false, "type": "string" }, { "in": "query", "name": "force", "required": false, "type": "boolean" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/research": { "get": { "operationId": "getCreatorResearch", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "type": "object" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Admin — DetailView *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/research/status": { "get": { "operationId": "getCreatorResearchStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "hoursUntilStale": { "type": "number", "format": "double", "x-nullable": true }, "findingsCount": { "type": "number", "format": "double" }, "lastUpdated": { "type": "string", "x-nullable": true }, "isStale": { "type": "boolean" }, "exists": { "type": "boolean" } }, "required": [ "hoursUntilStale", "findingsCount", "lastUpdated", "isStale", "exists" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/brand-suitability/global-users/{globalUserId}/reports/{reportId}/findings/exclude": { "put": { "operationId": "updateFindingExclusions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "$ref": "#/definitions/CreatorResearchRecord" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Frontend: Lightbox — ResearchFindingsTable action bar *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "reportId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateFindingExclusionsRequest" } } ] } }, "/v1/brand-suitability/stats": { "get": { "operationId": "getReportStats", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReportStatsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "BrandSuitability" ], "parameters": [] } }, "/v1/brand-suitability/batches": { "post": { "operationId": "createBatch", "produces": [ "application/json" ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/CreateBatchResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Frontend: Bulk dashboard — create a batch of reports for a set of creators (explicit ids or a search query). *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateBatchRequest" } } ] }, "get": { "operationId": "listBatches", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListBatchesResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Bulk dashboard — list batches for the community (cached counters; no report reads). *", "tags": [ "BrandSuitability" ], "parameters": [] } }, "/v1/brand-suitability/batches/{batchId}": { "get": { "operationId": "getBatch", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BatchDetailResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Frontend: Bulk dashboard — batch detail: per-creator status table + derived counts. *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "batchId", "required": true, "type": "string" } ] } }, "/v1/brand-suitability/batches/{batchId}/creators": { "post": { "operationId": "addBatchCreators", "produces": [ "application/json" ], "responses": { "202": { "description": "Accepted", "schema": { "$ref": "#/definitions/AddCreatorsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Frontend: Bulk dashboard — add more creators to an existing batch (R4). *", "tags": [ "BrandSuitability" ], "parameters": [ { "in": "path", "name": "batchId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AddCreatorsRequest" } } ] } }, "/v1/instances/{instanceId}/brands": { "get": { "operationId": "listInstanceBrands", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/InstanceBrandListItem" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InstanceBrands" ], "parameters": [ { "in": "path", "name": "instanceId", "required": true, "type": "string" } ] } }, "/v1/budgets/action-groups": { "get": { "operationId": "getActionGroupBudgets", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupBudgetsResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group budget not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Budgets" ], "parameters": [ { "in": "query", "name": "actionGroupStatuses", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "READY", "PENDING", "LIVE", "PAUSED", "EXPIRED", "ARCHIVED" ], "x-nullable": false } }, { "in": "query", "name": "types", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string", "enum": [ "STRIPE", "PAYPAL", "MAVELY", "TIPALTI", "TANGO_CARDS", "MANUAL_CASH_PAYMENT", "MANUAL_GIFT_CARD", "SHOPIFY_DISCOUNT", "PRODUCT", "PROMO_CODE", "OTHER" ], "x-nullable": false } } ] } }, "/v1/budgets/influencers": { "get": { "operationId": "getInfluencersBudget", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerBudgetsResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group budget not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Budgets" ], "parameters": [ { "in": "query", "name": "actionGroupIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/budgets/community": { "get": { "operationId": "getCommunityBudgets", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunityBudgetsResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group budget not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Budgets" ], "parameters": [] } }, "/v1/budgets/bulk": { "post": { "operationId": "bulkCreateBudgets", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkBudgetCreateResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group budget not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Budgets" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BulkBudgetCreateDTO" } } ] } }, "/v1/budgets": { "post": { "operationId": "createBudget", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BudgetEntity" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group budget not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Budgets" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BudgetCreateDTO" } } ] } }, "/v1/campaign-performance/post-metrics": { "get": { "operationId": "getPostMetrics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" } }, "required": [ "totalCount", "limit", "offset" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/PostMetric" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignPerformance" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" }, { "default": 20, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "default": "engagements", "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "impressions", "engagements", "impressionsEngagementRate", "emvValue" ] }, { "default": "DESC", "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] } ], "x-sharedCipherParameters": { "actionGroupId": "actionGroupId" } } }, "/v1/campaign-performance/influencers-metrics": { "get": { "operationId": "getInfluencersMetrics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" } }, "required": [ "totalCount", "limit", "offset" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/TopInfluencerMetrics" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignPerformance" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "default": 20, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "default": "engagements", "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "impressions", "engagements", "impressionsEngagementRate", "emvValue", "roiValue" ] }, { "default": "DESC", "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] } ], "x-sharedCipherParameters": { "actionGroupId": "actionGroupId" } } }, "/v1/campaign-performance/influencers-conversions": { "get": { "operationId": "getInfluencersConversions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" } }, "required": [ "totalCount", "limit", "offset" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/TopInfluencerConversions" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignPerformance" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "default": 20, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "default": "conversions", "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "clicks", "conversions", "conversionsValue" ] }, { "default": "DESC", "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] } ], "x-sharedCipherParameters": { "actionGroupId": "actionGroupId" } } }, "/v1/api/content-activations": { "post": { "operationId": "receiveCampaignPlatformFulfillmentCallback", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "CampaignPlatformCallback" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CampaignPlatformSubscriptionCallbackPayload" } } ] } }, "/v1/campaigns": { "get": { "operationId": "getAllCampaigns", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetAllCampaignsResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Campaigns" ], "parameters": [ { "in": "query", "name": "name", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" } ] }, "post": { "operationId": "createCampaign", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CampaignURI" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Campaigns" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "type": "object" } } ] } }, "/v1/campaigns/{id}": { "get": { "operationId": "getCampaignById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Campaign" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Campaigns" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateCampaign", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Campaigns" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "type": "object" } } ] }, "delete": { "operationId": "Delete", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Campaigns" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/campaigns/reporting-group/ids": { "get": { "operationId": "getActionGroupIdsForReportingGroup", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ReportingGroupIdsRespnse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Campaigns" ], "parameters": [ { "in": "query", "name": "reportingGroupIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/cash-payment-apps": { "get": { "operationId": "getCashPaymentApps", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/Partial_CashPaymentAppResponse_" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CashPayments" ], "parameters": [ { "default": false, "in": "query", "name": "checkEnabledProvider", "required": false, "type": "boolean" } ] }, "post": { "operationId": "createCashPaymentApp", "produces": [ "application/json" ], "responses": { "201": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "CashPayments" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateCashPaymentAppBody" } } ] } }, "/v1/cash-payment-apps/{id}": { "get": { "operationId": "getCashPaymentApp", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "$ref": "#/definitions/Partial_CashPaymentAppResponse_" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CashPayments" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "patch": { "operationId": "updateCashPaymentApp", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CashPaymentAppUpdateResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "CashPayments" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CashPaymentAppUpdatePayload" } } ] } }, "/v1/action-groups/{actionGroupId}/global-users/{globalUserId}/anonymous-comments": { "post": { "operationId": "createAnonymousComment", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DBAnonymousComment" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "AnonymousComments" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateAnonymousCommentBody" } } ] }, "get": { "operationId": "queryAnonymousComments", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/QueryAnonymousCommentsResult" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AnonymousComments" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "default": 15, "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "default": 0, "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "default": "createdAt", "in": "query", "name": "orderBy", "required": false, "type": "string" }, { "default": "DESC", "in": "query", "name": "orderDirection", "required": false, "type": "string" } ] } }, "/v1/global-users/{globalUserId}/comments": { "get": { "operationId": "getGlobalUserComments", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/Comment" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data", "meta" ], "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Comments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] }, "post": { "operationId": "createGlobalUserComment", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Pick_Comment.id_" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Comments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/GlobalUserCommentPostBody" } } ] } }, "/v1/global-users/{globalUserId}/comments/{commentId}": { "patch": { "operationId": "updateGlobalUserComment", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Comment" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Comments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "commentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/GlobalUserCommentPatchBody" } } ] } }, "/v1/notification_comments": { "get": { "operationId": "getNotificationComments", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_NotificationComment-Array_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Comments" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" }, { "in": "query", "name": "resourceType", "required": false, "type": "string" }, { "in": "query", "name": "resourceId", "required": false, "type": "string" }, { "in": "query", "name": "author", "required": false, "type": "string" } ] }, "post": { "operationId": "createNotificationComment", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Comments" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/NotificationCommentPostBody" } } ] } }, "/v1/comm-info": { "get": { "operationId": "getCommunityInfoWithAffiliates", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/CommSiteInfo" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidationError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Community" ], "parameters": [] }, "put": { "operationId": "updateCommmunityInfo", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "additionalProperties": true } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidationError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Community" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateCommunityInfoFieldsDTO" } } ] } }, "/comm/{communityId}/info": { "get": { "operationId": "getCommunityInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommSiteInfo" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Community" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" } ] } }, "/comm/{communityId}/news": { "get": { "operationId": "getCommunityNews", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/DBCommunityNews" }, "type": "array" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Community" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/communities/{communityId}/deactivate": { "post": { "operationId": "deactivateInstance", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InstanceDeactivation" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/communities/{communityId}/reactivate": { "post": { "operationId": "reactivateInstance", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InstanceDeactivation" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/community/{communityId}/reactivate": { "post": { "operationId": "reactivateInstance", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InstanceReactivation" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" } ] } }, "/v1/concept-content/{conceptContentId}/comments": { "post": { "operationId": "createConceptContentComment", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ConceptContentCommentPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConceptContentCommentPostBody" } } ] } }, "/v1/concept-content/{conceptContentId}/comments/{id}": { "put": { "operationId": "updateConceptContentComment", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConceptContentCommentPutBody" } } ] } }, "/v1/concept-content/{conceptContentId}/status": { "put": { "operationId": "updateConceptContentStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConceptContentStatusUpdateBody" } } ] } }, "/v1/concept-content/{conceptContentId}/feedback": { "put": { "operationId": "updateConceptContentFeedback", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConceptContentFeedbackUpdateBody" } } ] }, "get": { "operationId": "getConceptContentFeedback", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ConceptContentFeedbackEntry-Array_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/concept-content/{conceptContentId}/feedback/{id}": { "delete": { "operationId": "archiveConceptContentFeedback", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/concept-content": { "post": { "operationId": "createConceptContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerConceptContentDto" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "body", "name": "conceptContentData", "required": true, "schema": { "$ref": "#/definitions/AdminConceptContentPostBody" } } ] } }, "/v1/concept-content/{conceptContentId}": { "put": { "operationId": "updateConceptContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConceptContentUpdateBody" } } ] }, "delete": { "operationId": "archiveConceptContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/concept-content/{conceptContentId}/view": { "post": { "operationId": "createConceptContentViewed", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConceptViewed" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "conceptContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateConceptContentViewed" } } ] } }, "/v1/list-member/{listMemberId}/concept-content": { "get": { "operationId": "getConceptContentForListMember", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerConceptContentGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Concepts" ], "parameters": [ { "in": "path", "name": "listMemberId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "viewedByEmail", "required": false, "type": "string" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, { "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "createdAt" ] } ] } }, "/v1/content": { "get": { "operationId": "GetContent", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ContentResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Content" ], "parameters": [ { "in": "query", "name": "activationIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "communityId", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" } ] } }, "/v1/conversation-templates": { "get": { "operationId": "getConversationTemplates", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConversationTemplatesGetResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ConversationTemplates" ], "parameters": [ { "in": "query", "name": "isArchived", "required": false, "type": "boolean" } ] }, "post": { "operationId": "createConversationTemplate", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/ConversationTemplatePostResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ConversationTemplates" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationTemplatePostBody" } } ] } }, "/v1/conversation-templates/{id}": { "get": { "operationId": "getConversationTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetConversationTemplateByIdResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ConversationTemplates" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateConversationTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "Updated", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ConversationTemplates" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationTemplatePutBody" } } ] } }, "/v1/conversations/bulk-action/read": { "post": { "operationId": "bulkMarkConversationsAsRead", "produces": [ "application/json" ], "responses": { "201": { "description": "updated" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Conversations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationBulkActionRequestBody" } } ] } }, "/v1/conversations/bulk-action/unread": { "post": { "operationId": "bulkMarkConversationsAsUnread", "produces": [ "application/json" ], "responses": { "201": { "description": "updated" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Conversations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationBulkActionRequestBody" } } ] } }, "/v1/conversations/bulk-action/archive": { "post": { "operationId": "bulkArchiveConversations", "produces": [ "application/json" ], "responses": { "201": { "description": "updated" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Conversations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationBulkActionRequestBody" } } ] } }, "/v1/conversations/bulk-action/unarchive": { "post": { "operationId": "bulkUnarchiveConversations", "produces": [ "application/json" ], "responses": { "201": { "description": "updated" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Conversations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConversationBulkActionRequestBody" } } ] } }, "/v1/inline-images": { "post": { "operationId": "uploadInlineImage", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UploadInlineImageResult" } }, "400": { "description": "Invalid Parameter.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden.", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error.", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "multipart/form-data" ], "tags": [ "Conversations" ], "parameters": [ { "in": "formData", "name": "file", "required": true, "type": "file" } ] } }, "/v1/communities/{communityId}/campaigns/{campaignId}/merge-tags": { "get": { "operationId": "getMergeTagsCatalog", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MergeTagsCatalogResponse" } }, "400": { "description": "Validation error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Campaign not found in this community", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "MergeTagsCatalog" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "path", "name": "campaignId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/messages/{messageId}/events": { "get": { "operationId": "getMessageEvents", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/QueryByMessageResult" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Conversations" ], "parameters": [ { "in": "path", "name": "messageId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "DESC", "ASC" ] }, { "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "occurredAt" ] }, { "in": "query", "name": "event", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } } ] } }, "/v1/conversions-tags": { "get": { "operationId": "getAllConversionTags", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ConversionTag-Array_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ConversionTags" ], "parameters": [ { "in": "query", "name": "name", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] }, "post": { "operationId": "createConversionTag", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ConversionTags" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ConversionTagPostBody" } } ] } }, "/v1/conversions-tags/{id}": { "get": { "operationId": "getAllConversionTags", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConversionTag" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ConversionTags" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "name", "required": false, "type": "string" } ] }, "put": { "operationId": "updateConversionTag", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ConversionTags" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ConversionTagPutBody" } } ] } }, "/v1/creator-summary/global-users/{globalUserId}": { "get": { "operationId": "getCreatorSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CachedCreatorSummaryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Returns the creator's stored profile summary for display (e.g. the lightbox\npage). Pure read of the `creator-summary` DynamoDB table — does not generate.\nResponds 404 when no summary has been stored yet; call PUT to generate one.", "tags": [ "CreatorSummary" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "refreshCreatorSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CachedCreatorSummaryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Generates a fresh profile summary for a global user and stores it in the\n`creator-summary` DynamoDB table, replacing any existing copy. Backs the\n\"refresh\" action on the lightbox page. Grounds on the creator's own posts\nfrom our records; pass `research=true` to additionally run a web-research\npass before writing (off by default).", "tags": [ "CreatorSummary" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "research", "required": false, "type": "boolean" } ] } }, "/v1/admin/custom-analytics/configs": { "get": { "operationId": "listCustomAnalyticsConfigs", "produces": [ "application/json" ], "responses": { "200": { "description": "Configs retrieved successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigsListResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "query", "name": "communityId", "required": false, "type": "string" }, { "in": "query", "name": "dashboardType", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] }, "post": { "operationId": "createCustomAnalyticsConfig", "produces": [ "application/json" ], "responses": { "201": { "description": "Config created successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateCustomAnalyticsConfigRequest" } } ] } }, "/v1/admin/custom-analytics/configs/{id}": { "get": { "operationId": "getCustomAnalyticsConfigById", "produces": [ "application/json" ], "responses": { "200": { "description": "Config retrieved successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateCustomAnalyticsConfig", "produces": [ "application/json" ], "responses": { "200": { "description": "Config updated successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateCustomAnalyticsConfigRequest" } } ] }, "delete": { "operationId": "deleteCustomAnalyticsConfig", "produces": [ "application/json" ], "responses": { "204": { "description": "Config deleted successfully" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/admin/custom-analytics/configs/community/{communityId}/dashboard-type/{dashboardType}": { "get": { "operationId": "getCustomAnalyticsConfigByCommunityAndType", "produces": [ "application/json" ], "responses": { "200": { "description": "Config retrieved successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "path", "name": "dashboardType", "required": true, "type": "string" } ] } }, "/v1/admin/custom-analytics/configs/default/dashboard-type/{dashboardType}": { "get": { "operationId": "getDefaultCustomAnalyticsConfigByType", "produces": [ "application/json" ], "responses": { "200": { "description": "Default template config retrieved successfully", "schema": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Admin" ], "parameters": [ { "in": "path", "name": "dashboardType", "required": true, "type": "string" } ] } }, "/v1/custom-analytics/omni-analytics/embed-dashboard": { "get": { "operationId": "getOmniAnalyticsDashboard", "produces": [ "application/json" ], "responses": { "200": { "description": "The embed URL has been successfully generated", "schema": { "$ref": "#/definitions/EmbedUrlResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Controller" ], "parameters": [ { "in": "query", "name": "dashboardType", "required": false, "type": "string" } ] } }, "/v1/custom-analytics/dashboard-types": { "get": { "operationId": "getDashboardTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "Dashboard types retrieved successfully", "schema": { "$ref": "#/definitions/DashboardTypesResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Custom Analytics Controller" ], "parameters": [ { "in": "query", "name": "instanceId", "required": true, "type": "string" } ] } }, "/v1/social-account-ingestion": { "post": { "operationId": "Post", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/Pick_GlobalUser.id-or-uuid_" }, "type": "array" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/RequestData" } } ] }, "patch": { "operationId": "Patch", "produces": [ "application/json" ], "responses": { "201": { "description": "created" }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/RequestData" } } ] } }, "/v1/membership-data-points": { "get": { "operationId": "getMembershipDataPoints", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/MembershipDataPointWithDefinitions" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "MembershipDataPoints" ], "parameters": [ { "in": "query", "name": "dataPoints", "required": false, "type": "string" }, { "in": "query", "name": "globalUserId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/membership-data-point/{membershipId}/{dataPointDefinitionId}": { "put": { "operationId": "updateDataPoint", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "MembershipDataPoints" ], "parameters": [ { "in": "path", "name": "membershipId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "dataPointDefinitionId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/UpdateMembershipDataPointBody" } } ] } }, "/v1/draft-content/{draftContentId}/comments": { "post": { "operationId": "createDraftContentComment", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DraftContentCommentPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/DraftContentCommentPostBody" } } ] } }, "/v1/draft-content/{draftContentId}/comments/{id}": { "put": { "operationId": "updateDraftContentComment", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/DraftContentCommentPutBody" } } ] } }, "/v1/draft-content/{draftContentId}/feedback/{id}": { "delete": { "operationId": "archiveDraftContentFeedback", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/draft-content/{draftContentId}/view": { "post": { "operationId": "createDraftContentViewed", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DraftContentViewed" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "DraftContentViewed" ], "parameters": [ { "in": "path", "name": "draftContentId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateDraftContentViewed" } } ] } }, "/v1/influencer-draft-content/{actionGroupId}": { "get": { "operationId": "getDraftContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerDraftContentGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] }, "post": { "operationId": "createDraftContent", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InfluencerDraftContentPostBody" } } ] } }, "/v1/list-member/{listMemberId}/draft-content": { "get": { "operationId": "getDraftContentForListMember", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerDraftContentGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Drafts" ], "parameters": [ { "in": "path", "name": "listMemberId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "viewedByEmail", "required": false, "type": "string" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, { "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "createdAt" ] } ] } }, "/v1/earned-media-value": { "post": { "operationId": "backfillEmv", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "EarnedMediaValue" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateEmvParams" } } ] } }, "/v1/earned-media-value/backfill-lists-and-list-members": { "post": { "operationId": "backfillEmvForListsAndListMembers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "EarnedMediaValue" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateEmvParams" } } ] } }, "/v1/elasticsearch/retrieveDocuments": { "post": { "operationId": "retrieveDocuments", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/GlobalUserElasticsearchDocument" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Elasticsearch" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/RetrieveGlobalUserElasticsearchDocumentsRequestBody" } } ] }, "get": { "operationId": "getIds", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "globalUserIds" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Elasticsearch" ], "parameters": [ { "in": "query", "name": "facebookProfileIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "instagramProfileIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "membershipIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/elasticsearch/removeMissingGlobalUsers": { "post": { "operationId": "removeMissingGlobalUsers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "globalUserIds", "count" ], "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Elasticsearch" ], "parameters": [] } }, "/v1/elasticsearch-options/options": { "get": { "operationId": "getOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "additionalProperties": true } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ElasticsearchOptions" ], "parameters": [ { "in": "query", "name": "field", "required": true, "type": "string" }, { "in": "query", "name": "userString", "required": false, "type": "string" } ] } }, "/v1/email-blocklist/{email}": { "delete": { "operationId": "deleteEmailBlocklist", "produces": [ "application/json" ], "responses": { "200": { "description": "Email removed from blocklists" }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Remove an email address from all SendGrid suppression groups.\nThis endpoint will attempt to remove the specified email from all existing\nsuppression groups (bounces, blocks, spam reports, unsubscribes, etc.)", "tags": [ "Email Suppressions" ], "parameters": [ { "description": "The email address to remove from blocklists", "in": "path", "name": "email", "required": true, "type": "string" } ] } }, "/v1/smtp-email": { "get": { "operationId": "getCurrentEmailSettings", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EmailSmtpDTO" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidationError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "EmailSettings" ], "parameters": [] } }, "/v1/smtp-email/{fromName}/{fromEmail}": { "put": { "operationId": "updateEmailSettings", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "additionalProperties": true } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidationError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "EmailSettings" ], "parameters": [ { "in": "path", "name": "fromName", "required": true, "type": "string" }, { "in": "path", "name": "fromEmail", "required": true, "type": "string" } ] } }, "/v1/email-settings": { "get": { "operationId": "get", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetEmailSettingsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "EmailSettings" ], "parameters": [ { "in": "query", "name": "id", "required": false, "type": "string" } ] }, "post": { "operationId": "post", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PostEmailSettingsResponse" }, "headers": {} }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "EmailSettings" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PostEmailSettingsRequest" } } ] } }, "/v1/entitlements": { "get": { "operationId": "getEntitlements", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Entitlements" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Entitlements" ], "parameters": [ { "in": "query", "name": "featureIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } } ] }, "put": { "operationId": "updateEntitlements", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Entitlements" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateEntitlementFields" } } ] } }, "/v1/entitlements/bulk": { "put": { "operationId": "bulkUpdateEntitlements", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkUpdateEntitlementsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Bulk enable/disable a feature flag for many communities in a single operation.\nReplaces the frontend pattern of firing N sequential PUT /v1/entitlements calls.\n\nAccepts three targeting modes (see BulkUpdateEntitlementsRequest):\n- allCommunities: updates every community + flips features.default_state\n- groups: backend resolves to matching community IDs (e.g. all omni instances)\n- communityIds: explicit list", "tags": [ "Entitlements" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BulkUpdateEntitlementsRequest" } } ] } }, "/v1/features": { "get": { "operationId": "getFeatures", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetFeaturesResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Features" ], "parameters": [] } }, "/v1/features/{featureId}": { "get": { "operationId": "getFeatureById", "produces": [ "application/json" ], "responses": { "200": { "description": "Feature retrieved successfully", "schema": { "$ref": "#/definitions/GetFeatureResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Features" ], "parameters": [ { "in": "path", "name": "featureId", "required": true, "type": "string" } ] }, "patch": { "operationId": "updateFeature", "produces": [ "application/json" ], "responses": { "200": { "description": "Feature updated successfully", "schema": { "$ref": "#/definitions/UpdateFeatureResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Features" ], "parameters": [ { "in": "path", "name": "featureId", "required": true, "type": "string" }, { "in": "body", "name": "updateData", "required": true, "schema": { "$ref": "#/definitions/UpdateFeatureRequest" } } ] } }, "/v1/event-logs": { "get": { "operationId": "getEventLogs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/EventLogGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "EventLogs" ], "parameters": [ { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderBy", "required": false, "type": "string" }, { "in": "query", "name": "eventType", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "resourceType", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "resourceId", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "invokedBy", "required": false, "type": "string" } ] }, "post": { "operationId": "postEventLog", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "EventLogs" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/EventLogPostRequestBody" } } ] } }, "/v1/external-campaign-application": { "post": { "operationId": "submitCampaignApplication", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "CampaignApplication" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ExternalCampaignApplicationRequest" } } ] } }, "/v1/external-campaign-application/connect-mavely": { "get": { "operationId": "linkMavely", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignApplication" ], "parameters": [ { "in": "query", "name": "mavely_profile_id", "required": true, "type": "string" }, { "in": "query", "name": "state", "required": true, "type": "string" } ] } }, "/v1/external-campaign-application/connect-mavely/url": { "get": { "operationId": "connectMavelyUrl", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "CampaignApplication" ], "parameters": [ { "in": "query", "name": "global_user_id", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "action_group_id", "required": true, "type": "string" } ] } }, "/v1/admin/external-clients": { "post": { "operationId": "createExternalClient", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/CreateExternalClientResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Create a new external client", "tags": [ "ExternalClients" ], "parameters": [ { "description": "The client details (name required, clientId and clientSecret optional for migration)", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateExternalClientBody" } } ] }, "get": { "operationId": "getAllExternalClients", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetAllClientsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Get all clients with their instances, or filter by clientId.\nIncludes deleted clients and separates active/inactive instances.", "tags": [ "ExternalClients" ], "parameters": [ { "description": "Optional client ID to filter results", "in": "query", "name": "clientId", "required": false, "type": "string" }, { "default": 1, "description": "Page number (default: 1)", "in": "query", "name": "page", "required": false, "format": "double", "type": "number" }, { "default": 20, "description": "Number of results per page (default: 20, max: 100)", "in": "query", "name": "pageSize", "required": false, "format": "double", "type": "number" } ] } }, "/v1/admin/external-clients/{clientId}/secrets": { "post": { "operationId": "regenerateExternalClientSecret", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RegenerateSecretResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Regenerate the client secret", "tags": [ "ExternalClients" ], "parameters": [ { "description": "The unique identifier for the client", "in": "path", "name": "clientId", "required": true, "type": "string" } ] } }, "/v1/admin/external-clients/{clientId}": { "delete": { "operationId": "deleteExternalClient", "produces": [ "application/json" ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/EmptySuccessResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Soft delete a client and all associated instances", "tags": [ "ExternalClients" ], "parameters": [ { "description": "The unique identifier for the client", "in": "path", "name": "clientId", "required": true, "type": "string" } ] } }, "/v1/admin/external-clients/{clientId}/instances": { "post": { "operationId": "associateExternalClientInstances", "produces": [ "application/json" ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/EmptySuccessResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Associate instances to a client", "tags": [ "ExternalClients" ], "parameters": [ { "description": "The unique identifier for the client", "in": "path", "name": "clientId", "required": true, "type": "string" }, { "description": "The instance IDs to associate", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AssociateInstancesBody" } } ] } }, "/v1/admin/external-clients/{clientId}/instances/{instanceId}": { "delete": { "operationId": "deleteExternalClientInstance", "produces": [ "application/json" ], "responses": { "204": { "description": "No Content", "schema": { "$ref": "#/definitions/EmptySuccessResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Soft delete a client instance association", "tags": [ "ExternalClients" ], "parameters": [ { "description": "The unique identifier for the client", "in": "path", "name": "clientId", "required": true, "type": "string" }, { "description": "The instance ID to remove", "in": "path", "name": "instanceId", "required": true, "type": "string" } ] } }, "/v1/mavely/transfers/{rewardWinId}": { "get": { "operationId": "getMavelyTransfer", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MavelyTransferWithStatusHistoryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "MavelyTransfers" ], "parameters": [ { "in": "path", "name": "rewardWinId", "required": true, "type": "string" } ] } }, "/v1/payment-recipients": { "post": { "operationId": "createPaymentRecipient", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "$ref": "#/definitions/PaymentRecipientView" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PaymentRecipientCreateRequest" } } ] } }, "/v1/payment-recipients/notification": { "post": { "operationId": "sendPaymentRecipientOnboardingReminder", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/OnboardingReminderRequestBody" } } ] } }, "/v1/payment-recipients/{uuid}": { "get": { "operationId": "getPaymentRecipient", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentRecipientView" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] } }, "/v1/payment-recipients/{uuid}/tipalti-payees/iframe-url": { "get": { "operationId": "getTipaltiPayeeIframeUrl", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TipaltiPayeeIframeUrlResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "path", "name": "uuid", "required": true, "type": "string" } ] } }, "/v1/payment-recipients/verifications": { "post": { "operationId": "requestPaymentRecipientVerification", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/VerificationCodeResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/VerificationCodeRequest" } } ] } }, "/v1/payment-recipients/verifications/confirm": { "post": { "operationId": "confirmPaymentRecipientVerification", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentRecipientView" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/VerificationConfirmRequest" } } ] } }, "/v1/payment-recipients/list-members/{listMemberId}": { "get": { "operationId": "getPaymentRecipientByListMemberId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "path", "name": "listMemberId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/payment-recipients/links/clear": { "post": { "operationId": "clearPaymentRecipientLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentRecipientLinksMutationResult" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Clears the payment-recipient link from every active campaign membership of\nthe given creators (account-level Later Pay disconnect). latergram resolves\nthe Later Social account to its creators' CDS creator_profile_ids and calls\nthis so all in-flight campaigns are severed at once; complete/archived\nmemberships keep their link.", "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ClearPaymentRecipientLinksRequest" } } ] } }, "/v1/payment-recipients/links/propagate": { "post": { "operationId": "propagatePaymentRecipientLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentRecipientLinksMutationResult" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Re-links every active campaign membership of the given creators to a newly\nconnected recipient (account-level Later Pay reconnect). Ensures a reconnect\nupdates all in-flight campaigns, not just the one being viewed.", "tags": [ "PaymentRecipient" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PropagatePaymentRecipientLinksRequest" } } ] } }, "/v1/stripe/payment-providers/bulk-enable": { "post": { "operationId": "configureStripeProviderAppToInstances", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ConfigureStripeProviderAppToInstanceResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "StripePayments" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigureStripeProviderAppToInstanceBody" } } ] } }, "/v1/stripe/accounts/create/{globalUserId}": { "post": { "operationId": "createStripeConnectedAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "country", "required": false, "type": "string" } ] } }, "/v1/stripe/accounts/notification": { "post": { "operationId": "sendStripeOnboardingReminder", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "StripePayments" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/OnboardingReminderRequestBody" } } ] } }, "/v1/stripe/accounts/{globalUserIds}": { "get": { "operationId": "getStripeAccountsByGlobalUserIds", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/StripeAccountStatusResponse" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "globalUserIds", "required": true, "type": "string" } ] } }, "/v1/stripe/accounts/account/{globalUserId}": { "get": { "operationId": "getStripeAccountByGlobalUserId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StripeAccount" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/stripe/accounts/{globalUserId}/disconnect": { "delete": { "operationId": "disconnectStripeAccountByGlobalUserId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "country", "required": false, "type": "string" } ] } }, "/v1/stripe/accounts/{globalUserId}/delete": { "delete": { "operationId": "deleteStripeAccountByGlobalUserId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "country", "required": false, "type": "string" } ] } }, "/v1/exchange-rates/stripe": { "get": { "operationId": "getStripeExchangeRates", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StripeExchangeRate" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [] } }, "/v1/stripe/transfers/{uniqueTransferId}": { "get": { "operationId": "getStripeTransfer", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StripeTransferWithStatusHistoryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "StripePayments" ], "parameters": [ { "in": "path", "name": "uniqueTransferId", "required": true, "type": "string" } ] } }, "/v1/tipalti-payees/{refCode}": { "get": { "operationId": "getTipaltiPayeeByRefCode", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TipaltiPayeeResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TipaltiPayee" ], "parameters": [ { "in": "path", "name": "refCode", "required": true, "type": "string" } ] } }, "/v1/tipalti/transfers/{rewardWinId}": { "get": { "operationId": "getTipaltiTransfer", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TipaltiTransferWithStatusHistoryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TipaltiTransfers" ], "parameters": [ { "in": "path", "name": "rewardWinId", "required": true, "type": "string" } ] } }, "/v1/gift-cards/email-templates": { "get": { "operationId": "getEmailTemplates", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GiftCards" ], "parameters": [] } }, "/v1/gift-cards/balance": { "get": { "operationId": "getGiftCardBalance", "produces": [ "application/json" ], "responses": { "200": { "description": "Available balance", "schema": { "type": "object" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GiftCards" ], "parameters": [] } }, "/v1/gift-cards/options": { "get": { "operationId": "getGiftCardOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GiftCards" ], "parameters": [] } }, "/v1/grouphigh/graphs/lightbox-tiktok": { "get": { "operationId": "getLightboxTikTokGraphs", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DemographicsGraphsResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GroupHigh" ], "parameters": [ { "in": "query", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/image-proxy": { "get": { "operationId": "proxyImage", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" } }, "tags": [ "Images" ], "parameters": [ { "in": "query", "name": "url", "required": true, "type": "string" } ] } }, "/v1/action-groups/{actionGroupId}/incentives/{id}": { "put": { "operationId": "assignIncentiveToActionGroup", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroups" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ActionGroupIncentivePutBody" } } ] }, "delete": { "operationId": "unassignIncentiveFromActionGroup", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroups" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/termsandconditions/template": { "get": { "operationId": "getTermsAndConditionsTemplate", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TermsAndConditionsTemplate" } }, "400": { "description": "Invalid Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Incentive not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Incentives" ], "parameters": [ { "in": "query", "name": "type", "required": true, "type": "string" }, { "in": "query", "name": "unlockType", "required": true, "type": "string" } ] } }, "/v1/incentives/{id}/unlock": { "post": { "operationId": "unlockIncentive", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Incentives" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/IncentiveUnlockPostBody" } } ] } }, "/v1/incentives": { "get": { "operationId": "getAll", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of incentives", "schema": { "$ref": "#/definitions/IncentivesGetResponse" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Incentives" ], "parameters": [] }, "post": { "operationId": "createIncentive", "produces": [ "application/json" ], "responses": { "200": { "description": "Incentive URI", "schema": { "$ref": "#/definitions/IncentiveURI" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Incentives" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CreateIncentivePostBody" } } ] } }, "/v1/incentives/{id}": { "get": { "operationId": "getById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Incentives" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateIncentive", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid/missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Incentives" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/UpdateIncentivePutBody" } } ] } }, "/v1/influencer-agreement": { "put": { "operationId": "updateIfluencerAgreementHistoryFields", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DBInfluencerAgreementHistoryFields" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "DBInfluencerAgreementHistoryFields" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateInfluencerAgreementHistoryFieldsBody" } } ] } }, "/v1/influencer-campaign-history": { "get": { "operationId": "getInfluencerCampaignHistory", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/InfluencerCampaignHistoryGetResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerCampaign" ], "parameters": [ { "in": "query", "name": "membershipId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "includeContent", "required": false, "type": "boolean" }, { "in": "query", "name": "hideOnIcm", "required": false, "type": "boolean" } ] } }, "/v1/influencer-campaign/{actionGroupId}": { "get": { "operationId": "getInfluencerCampaign", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LegacyInfluencerCampaignGetResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerCampaign" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/influencer-links/{globalUserId}": { "get": { "operationId": "getInfluencerLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetInfluencerLinksResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerLinks" ], "parameters": [ { "in": "path", "name": "globalUserId", "required": true, "type": "string" }, { "in": "query", "name": "actionGroupId", "required": false, "type": "string" } ] } }, "/v1/influencer-review-deliverable": { "post": { "operationId": "upsertReviewDeliverable", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "InfluencerReviewDeliverable" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/InfluencerReviewDeliverablePostBody" } } ] } }, "/v1/influencer-review-deliverable/{id}": { "delete": { "operationId": "deleteReviewDeliverable", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerReviewDeliverable" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/influencers/performance-list": { "get": { "operationId": "getInfluencerPerformanceList", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetInfluencerPerformanceListResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerList" ], "parameters": [ { "in": "query", "name": "orderBy", "required": true, "type": "string" }, { "in": "query", "name": "date", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/upload-policy": { "post": { "operationId": "uploadPolicy", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/SigningData" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "uploadPolicy" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/FileUploadPoliciesPostBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{actionGroupId}/post-partnership-requests": { "get": { "operationId": "getInfluencerPostPartnershipRequests", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/MetaPostPartnershipRequestDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{actionGroupId}/post-partnership-requests/{requestId}": { "patch": { "operationId": "updateInfluencerPostPartnershipRequest", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MetaPostPartnershipRequestDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "requestId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateInfluencerPostPartnershipRequestRequestBody" } } ] } }, "/v1/later-influencers/{influencerIdOrCreatorId}/campaigns/{actionGroupId}/post-partnership-sponsor": { "get": { "operationId": "getInfluenerPostPartnershipSponsor", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MetaInstagramAccountDto" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "LaterInfluencer" ], "parameters": [ { "in": "path", "name": "influencerIdOrCreatorId", "required": true, "type": "string" }, { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/instagram-profiles/update-profile-picture": { "post": { "operationId": "updateInstagramProfilePicture", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "InstagramAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateInstagramProfilePictureRequest" } } ] } }, "/v1/instagram-profiles/{instagramProfileId}/active": { "post": { "operationId": "activateInstagramProfile", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InstagramAccount" ], "parameters": [ { "in": "path", "name": "instagramProfileId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{id}/links": { "get": { "operationId": "getLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LinksGetResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Links" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "listMemberId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "includeDeleted", "required": false, "type": "boolean" }, { "in": "query", "name": "mavelyProfileId", "required": false, "type": "string" } ] }, "post": { "operationId": "postLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Links" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/LinkPostRequest" } } ] } }, "/v1/action-groups/{id}/links/{linkId}": { "put": { "operationId": "updateLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LinksPostResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Links" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "linkId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/LinkPutRequest" } } ] }, "delete": { "operationId": "archiveLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Links" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "path", "name": "linkId", "required": true, "type": "string" } ] } }, "/v1/action-groups/{id}/specs": { "get": { "operationId": "getSpecs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SpecsGetResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Specs" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "query", "name": "title", "required": false, "type": "string" }, { "in": "query", "name": "destinationUrl", "required": false, "type": "string" }, { "in": "query", "name": "includeCommissions", "required": false, "type": "boolean" } ] }, "post": { "operationId": "postSpecs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Specs" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SpecsPostRequest" } } ] } }, "/v1/action-groups/{id}/specs/{specId}": { "put": { "operationId": "updateSpecs", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "additionalProperties": true } }, "required": [ "data" ], "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Specs" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "specId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SpecsPutRequest" } } ] }, "delete": { "operationId": "archiveSpec", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Specs" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "specId", "required": true, "type": "string" } ] } }, "/v1/action-groups/{id}/specs/brand-details": { "get": { "operationId": "getBrandDetails", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Specs" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "link", "required": true, "type": "string" }, { "default": true, "in": "query", "name": "metadataIncluded", "required": false, "type": "boolean" } ] } }, "/v1/action-groups/{actionGroupId}/custom-influencer-statuses": { "get": { "operationId": "getInfluencerStatuses", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ListCustomInfluencerStatus-Array_" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupCustomInfluencerStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] }, "post": { "operationId": "createInfluencerStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListCustomInfluencerStatusesResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupCustomInfluencerStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ListCustomInfluencerStatusPostRequestBody" } } ] } }, "/v1/action-groups/{actionGroupId}/custom-influencer-statuses/{id}": { "delete": { "operationId": "deleteInfluencerStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupCustomInfluencerStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateInfluencerStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupCustomInfluencerStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ListCustomInfluencerStatusPutRequestBody" } } ] } }, "/v1/action-groups/{actionGroupId}/custom-statuses": { "get": { "operationId": "getTrackingStatuses", "produces": [ "application/json" ], "responses": { "200": { "description": "A collection of tracking statuses", "schema": { "$ref": "#/definitions/ActionGroupCustomStatusesGetResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupCustomStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "all", "required": false, "type": "boolean" } ] }, "post": { "operationId": "createTrackingStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Tracking status created successfully", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupCustomStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ListCustomStatus" } } ] } }, "/v1/action-groups/{actionGroupId}/custom-statuses/{id}/reorder": { "put": { "operationId": "reorderTrackingStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Action group custom status updated successfully", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupCustomStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ListCustomStatus" } } ] } }, "/v1/action-groups/{actionGroupId}/custom-statuses/{id}": { "put": { "operationId": "updateTrackingStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Action group custom status updated successfully", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupCustomStatuses" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/Partial_ListCustomStatus_" } } ] } }, "/v1/action-groups/custom-statuses/{id}/delete": { "delete": { "operationId": "deleteTrackingStatus", "produces": [ "application/json" ], "responses": { "200": { "description": "Action group custom status deleted successfully", "schema": { "$ref": "#/definitions/ActionGroupCustomStatusDeleteResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ActionGroupCustomStatuses" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/lists/{listId}/list-deliverables": { "post": { "operationId": "createListDeliverable", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListDeliverable" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListDeliverableRequest" } } ] } }, "/v1/lists/{listId}/list-deliverables/{id}": { "put": { "operationId": "updateListDeliverable", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListDeliverableRequest" } } ] }, "delete": { "operationId": "deleteListDeliverable", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/lists/{listId}/list-member-deliverables": { "post": { "operationId": "createListMemberDeliverable", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberDeliverable" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberDeliverablePostRequest" } } ] }, "get": { "operationId": "getListMemberDeliverables", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberDeliverableGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "listMemberId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "contentType", "required": false, "type": "string" }, { "in": "query", "name": "listCustomStatusId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/lists/{listId}/list-member-deliverables/bulk-assign": { "post": { "operationId": "bulkAssignDeliverables", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberDeliverableBulkAssignPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberDeliverableBulkAssignPostRequest" } } ] } }, "/v1/lists/{listId}/list-member-deliverables/bulk-assign-summary": { "post": { "operationId": "queryBulkAssignSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberDeliverableBulkAssignSummaryPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberDeliverableBulkAssignSummaryPostRequest" } } ] } }, "/v1/lists/{listId}/list-member-deliverables/{listMemberDeliverableId}": { "put": { "operationId": "updateListMemberDeliverable", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "listMemberDeliverableId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ListMemberDeliverablePutRequest" } } ] }, "delete": { "operationId": "deleteListMemberDeliverable", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "listMemberDeliverableId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/lists/{listId}/list-member-deliverables/summary": { "get": { "operationId": "getListMemberDeliverablesSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ListMemberDeliverablesSummaryGetResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberDeliverables" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "listCustomStatusId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/bulk-messages-schedule": { "post": { "operationId": "createBulkListMemberScheduledMessage", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupBulkScheduledMessages" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BulkActionGroupScheduleMessagePostBody" } } ] } }, "/v1/messages-scheduling": { "post": { "operationId": "createListMemberScheduledMessage", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DBScheduledMessage" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupScheduledMessages" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupScheduledMessagePostBody" } } ] }, "put": { "operationId": "editListMemberScheduledMessage", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DBScheduledMessage" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupScheduledMessages" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupScheduledMessagePutBody" } } ] } }, "/v1/messages-scheduling/schedule-reply": { "post": { "operationId": "replyListMemberScheduledMessage", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/ScheduledReplyMessageResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupScheduledMessages" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ScheduledReplyMessagePostBody" } } ] } }, "/v1/messages-scheduling/send-now": { "post": { "operationId": "sendScheduledMessageNow", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/DBMessage" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ActionGroupScheduledMessages" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ActionGroupScheduledMessageSendNowBody" } } ] } }, "/v1/lists/{listId}/users/{id}": { "get": { "operationId": "getUserIfListMember", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Lists" ], "parameters": [ { "in": "path", "name": "listId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/list-member-mavely-profiles": { "get": { "operationId": "findAllListMemberMavelyProfiles", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/ListMemberMavelyProfile" }, "type": "array" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberMavelyProfiles" ], "parameters": [ { "in": "query", "name": "mavelyProfileId", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "listMemberId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "globalUserId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/list-members/mavely/profiles": { "post": { "operationId": "getListMemberMavelyProfiles", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/ListMemberMavelyProfile" }, "type": "array" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberMavelyProfiles" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MavelyProfilesRequest" } } ] } }, "/v1/list-members/disconnect/mavely": { "delete": { "operationId": "deleteListMemberMavelyProfilesByActionGroupId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberMavelyProfiles" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/list-members": { "post": { "operationId": "getListMemberGlobalUserIds", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMembers" ], "parameters": [ { "in": "body", "name": "filters", "required": true, "schema": { "$ref": "#/definitions/ListMemberFilters" } } ] } }, "/v1/notification-groups": { "put": { "operationId": "updateNotificationGroups", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "MarketerNotifications" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateNotificationBodyDefinition" } } ] } }, "/v1/notification-preferences/{actionGroupId}": { "put": { "operationId": "setNotificationPreferences", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "MarketerNotifications" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SetNotificationPreferenceBodyDefinition" } } ] } }, "/v1/membership-points-for-purchase": { "post": { "operationId": "awardPointsForPurchase", "produces": [ "application/json" ], "responses": { "200": { "description": "Successfully awarded points for a purchase event", "schema": { "$ref": "#/definitions/PostMembershipPurchaseResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Points already awarded for this purchase", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "MembershipPurchases" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/PostMembershipPurchaseBody" } } ] } }, "/v1/membership/contact-info": { "get": { "operationId": "getMembershipContactInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/_MembershipContactInfo" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Membership" ], "parameters": [] }, "put": { "operationId": "updateMembershipContactInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Membership" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/MembershipContactInfoDeprecated" } } ] } }, "/v1/influencers/{id}/contact-info": { "put": { "operationId": "updateInfluencerContactInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "description": "Update a My Members creator contact info.", "tags": [ "Membership" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/UpdateInfluencerContactInfoBody" } } ] } }, "/v1/membership/signature": { "put": { "operationId": "updateSignature", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Membership" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/updateSignatureBody" } } ] } }, "/v1/membership/summary": { "get": { "operationId": "getMembershipSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMembershipSummaryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Membership" ], "parameters": [] } }, "/v1/membership-profile-info": { "put": { "operationId": "updateMembershipProfileInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Membership" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateMembershipProfileInfo" } } ] } }, "/v1/membership/{id}": { "get": { "operationId": "getMembership", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetMembershipResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Membership" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "updateMembership", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Membership" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/updateMembershipBody" } } ] } }, "/v1/remove-membership": { "post": { "operationId": "removeMembership", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Membership" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/removeMembershipBody" } } ] } }, "/v1/admin/meta/system-users/ad-accounts": { "get": { "operationId": "GetSystemUsersAdAccountsInfo", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/MetaSystemUsersAdAccountsResponse" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Ad Admin" ], "parameters": [] } }, "/v1/admin/meta/backfill/ad-insights": { "post": { "operationId": "backfillAdAccountInsightsData", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Ad Admin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillMetaAdInsightsJobPayload" } } ] } }, "/v1/admin/meta/backfill/ad-insights/push": { "post": { "operationId": "pushAdAccountInsightsData", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Ad Admin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PushMetaAdInsightsJobPayload" } } ] } }, "/v1/admin/meta/backfill/ads": { "post": { "operationId": "backfillAdInformationForAdAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Ad Admin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillMetaAdInsightsJobPayload" } } ] } }, "/v1/admin/meta/backfill/ads/lifetime-insights": { "post": { "operationId": "backfillLifetimeAdInsights", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Ad Admin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BackfillMetaAdInsightsJobPayload" } } ] } }, "/v2/marketers/meta/business/assets": { "get": { "operationId": "getBusinessAssets", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/MetaBusinessAssetAuthorizationDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Business Assets" ], "parameters": [] } }, "/v2/marketers/meta/business/assets/{id}": { "patch": { "operationId": "updateBusinessAsset", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/MetaBusinessAssetAuthorizationDto" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Business Assets" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateBusinessAssetRequestBody" } } ] } }, "/v2/marketers/meta/business/portfolios": { "get": { "operationId": "getBusinessPortfolios", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/MetaBusinessPortfolioAuthorizationDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Business Portfolios" ], "parameters": [] } }, "/v2/marketers/meta/business/portfolios/{id}": { "patch": { "operationId": "updateBusinessPortfolio", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/MetaBusinessPortfolioAuthorizationDto" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Business Portfolios" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateBusinessPortfolioRequestBody" } } ] } }, "/v2/marketers/meta/business/integrations": { "delete": { "operationId": "disconnectBusinessIntegrations", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Business Integrations" ], "parameters": [] }, "post": { "operationId": "connectBusinessIntegration", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "$ref": "#/definitions/MetaBusinessIntegrationDto" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Business Integrations" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MetaConnectBusinessIntegrationRequestBody" } } ] }, "get": { "operationId": "getBusinessIntegrations", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/MetaBusinessIntegrationDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Business Integrations" ], "parameters": [] } }, "/v2/marketers/meta/business/integrations/{id}": { "patch": { "operationId": "enableBusinessIntegration", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/MetaBusinessIntegrationDto" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Business Integrations" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MetaEnableBusinessIntegrationRequestBody" } } ] } }, "/v2/marketers/meta/post-partnership-requests": { "post": { "operationId": "createMetaPostPartnershipRequest", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "$ref": "#/definitions/MetaPostPartnershipRequestDto" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Meta Post Partnerships" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MetaCreatePostPartnershipRequestBody" } } ] }, "get": { "operationId": "getMetaPostPartnershipRequests", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/MetaPostPartnershipRequestDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Meta Post Partnerships" ], "parameters": [ { "in": "query", "name": "activationIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/networks": { "get": { "operationId": "getAllNetworks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": true } }, "400": { "description": "Invalid or missing parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Networks" ], "parameters": [] } }, "/v1/open-ai-search": { "post": { "operationId": "search", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "additionalProperties": true, "x-nullable": true } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "OpenAISearch" ], "parameters": [ { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/OpenAISearchBody" } } ] } }, "/webhooks/later/opt-in": { "post": { "operationId": "optIn", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "OptIn" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CreatorOptInRequestWithCreatorProfileId" } } ] } }, "/webhooks/later/update": { "post": { "operationId": "optInUpdate", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "OptIn" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CreatorOptInRequestWithCreatorProfileId" } } ] } }, "/webhooks/later/opt-out": { "post": { "operationId": "optInOptOut", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "OptIn" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CreatorOptOutRequest" } } ] } }, "/v1/payments-ledgerV2": { "get": { "operationId": "getPaymentsLedgerV2", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentsLedgerQueryResponse" } }, "400": { "description": "Validation error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentsLedger" ], "parameters": [ { "in": "query", "name": "fromDate", "required": true, "format": "date-time", "type": "string" }, { "in": "query", "name": "toDate", "required": true, "format": "date-time", "type": "string" }, { "in": "query", "name": "onlyMostRecent", "required": true, "type": "boolean" }, { "in": "query", "name": "paymentAccountIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "actionGroupIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "globalUserIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "rewardWinTypes", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "transactionStatuses", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "DESC", "ASC", "" ] }, { "in": "query", "name": "orderProperty", "required": false, "type": "string", "enum": [ "paymentAccountTransactionId", "transactionDateTime", "rewardWinType", "recipientFullName", "actionGroupTitle", "cost", "value", "transactionStatus", "paymentAccountTitle" ] }, { "in": "query", "name": "budgetReferenceId", "required": false, "type": "string" } ] } }, "/v1/payments-ledgerV2/{rewardWinId}": { "get": { "operationId": "getMostRecentLedgerRecordForRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Validation error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentsLedger" ], "parameters": [ { "in": "path", "name": "rewardWinId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/payments-ledgerV2/stripe/{rewardWinId}": { "get": { "operationId": "getMostRecentLedgerRecordForStripeRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Validation error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentsLedger" ], "parameters": [ { "in": "path", "name": "rewardWinId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/exchange-rates": { "get": { "operationId": "getExchangeRates", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_ExchangeRate_" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ExchangeRates" ], "parameters": [ { "in": "query", "name": "currencyCode", "required": true, "type": "string" } ] } }, "/v1/payment-accounts": { "get": { "operationId": "getInstancePaymentAccounts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/DBPaymentAccountWithAssociations" }, "type": "array" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [] }, "post": { "operationId": "createPaymentAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DBPaymentAccount" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreatePaymentAccountData" } } ] } }, "/v1/payment-accounts/net-deposits": { "get": { "operationId": "getNetDepositsForPaymentAccounts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/PaymentAccountNetDeposits" }, "type": "array" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [ { "in": "query", "name": "paymentAccountIds", "required": true, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } } ] } }, "/v1/payment-accounts/{paymentAccountId}": { "get": { "operationId": "getPaymentAccountById", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DBPaymentAccountWithAssociations" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "paymentAccountId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/payment-accounts/{paymentAccountId}/transactions": { "post": { "operationId": "recordAccountingTransaction", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "paymentAccountId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AccountingTransactionCreateDetails" } } ] } }, "/v1/payment-accounts/info/supported-currencies": { "get": { "operationId": "getStripeSupportedCurrencies", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StripeSupportedCurrencies" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [] } }, "/v1/payment-accounts/info/instance": { "get": { "operationId": "getInstanceInternationalCurrencies", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [] } }, "/v1/payment-accounts/instance/{instanceId}": { "get": { "operationId": "getPaymentAccountByInstanceId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "instanceId", "required": true, "type": "string" } ] }, "put": { "operationId": "updateInstanceInternationalCurrency", "produces": [ "application/json" ], "responses": { "200": { "description": "Instance international currencies updated successfully", "schema": { "$ref": "#/definitions/Partial_PaymentAccountSupportedCurrencies_" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "instanceId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PaymentAccountSupportedCurrenciesRequestBody" } } ] } }, "/v1/payment-accounts/{paymentAccountId}/transactions/{transactionId}/reward-wins/{rewardWinId}": { "patch": { "operationId": "updateTransactionAndRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "paymentAccountId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "transactionId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "rewardWinId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/TaxUpdateRequestDTO" } } ] } }, "/v1/payment-accounts/{paymentAccountId}/transactions/{transactionId}": { "patch": { "operationId": "updateTransaction", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentAccount" ], "parameters": [ { "in": "path", "name": "paymentAccountId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "transactionId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdatePaymentAccountTransactionRequestDTO" } } ] } }, "/v1/payment-app-admins": { "get": { "operationId": "getPaymentAppAdmin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentAppAdmin" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentAppAdmins" ], "parameters": [] } }, "/v1/payment-providers": { "get": { "operationId": "getInstancePaymentProviderApps", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/PaymentProvider" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PaymentProvider" ], "parameters": [] } }, "/v1/mvk-payment-provider": { "post": { "operationId": "configureMavrckProviderAppToInstance", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PaymentProvider" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PaymentProvider" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConfigureMavrckProviderAppToInstanceBody" } } ] } }, "/v1/pinterest/global-users/auth": { "post": { "operationId": "authenticatePinterest", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PinterestAuthPostResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PinterestAuth" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PinterestAuthPostRequestBody" } } ] } }, "/v1/pinterest/global-users/redirect": { "get": { "operationId": "authenticatePinterestRedirect", "produces": [ "application/json" ], "responses": { "302": { "description": "Redirect" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PinterestAuth" ], "parameters": [ { "in": "query", "name": "code", "required": true, "type": "string" }, { "in": "query", "name": "state", "required": true, "type": "string" } ] } }, "/v1/creator-profile-upsert": { "post": { "operationId": "handleCreatorProfileUpsert", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "CreatorProfileUpsert" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CreatorProfileUpsertEvent" } } ] } }, "/v1/expiring-access-tokens": { "post": { "operationId": "handleExpiringAccessToken", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ExpiringAccessTokens" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ExpiringAccessTokenEvent" } } ] } }, "/v1/social-presence-create": { "post": { "operationId": "handleSocialPresenceCreate", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "SocialPresenceCreate" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/SocialPresenceCreateEvent" } } ] } }, "/v1/social-profile-updates": { "post": { "operationId": "handleSocialProfileUpdate", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "SocialProfileUpdates" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/SocialProfileUpdateEvent" } } ] } }, "/v1/points-admin/action-objective-definition": { "get": { "operationId": "getCommunityActionObjectiveDefinitions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCommunityActionObjectiveResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PointsAdmin" ], "parameters": [] }, "put": { "operationId": "setCommunityActionObjectiveDefinition", "produces": [ "application/json" ], "responses": { "200": { "description": "Update successful", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PointsAdmin" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/CommunityActionObjectiveDefinition" } } ] } }, "/v1/points-admin/engagement-point-mapping": { "get": { "operationId": "getEngagementPointMapping", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetCommunityEngagementPointMappingResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PointsAdmin" ], "parameters": [] }, "put": { "operationId": "setEngagementPointMapping", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PointsAdmin" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CommunityEngagementPointMapping" } } ] } }, "/v1/polling/management/queues/purge": { "post": { "operationId": "purgePollingQueue", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue purge initiated", "schema": { "$ref": "#/definitions/PurgeQueueResponse" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Purge all messages from a specific polling queue.\nNote: Only one purge operation is allowed per queue every 60 seconds.", "tags": [ "Polling Queue Management" ], "parameters": [ { "description": "The queue type to purge (instagram, instagram-story, or non-instagram)", "in": "query", "name": "queue", "required": true, "type": "string", "enum": [ "instagram", "instagram-story", "non-instagram" ] } ] } }, "/v1/polling/management/queues/stats": { "get": { "operationId": "getAllPollingQueueStats", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue stats returned", "schema": { "$ref": "#/definitions/AllQueueStatsResponse" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Get statistics for all polling queues (Instagram, Instagram Story, Non-Instagram).\nReturns approximate message counts for each queue.", "tags": [ "Polling Queue Management" ], "parameters": [] } }, "/v1/polling/management/queues/stats/single": { "get": { "operationId": "getSinglePollingQueueStats", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue stats returned", "schema": { "$ref": "#/definitions/QueueStats" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "description": "Get statistics for a specific polling queue.", "tags": [ "Polling Queue Management" ], "parameters": [ { "description": "The queue type to get stats for (instagram, instagram-story, or non-instagram)", "in": "query", "name": "queue", "required": true, "type": "string", "enum": [ "instagram", "instagram-story", "non-instagram" ] } ] } }, "/v1/power-reviews-app": { "post": { "operationId": "createPowerReviewsApp", "produces": [ "application/json" ], "responses": { "200": { "description": "App created", "schema": { "type": "object" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "422": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "PowerReviewsApp" ], "parameters": [ { "in": "body", "name": "requestBody", "required": true, "schema": { "$ref": "#/definitions/PowerReviewsAppPostBody" } } ] }, "get": { "operationId": "getPowerReviewsAppAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PowerReviewsAppsGetResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "422": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PowerReviewsApp" ], "parameters": [] } }, "/v1/preview-posts": { "get": { "operationId": "getPreviewPosts", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/PreviewPost" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "PreviewPosts" ], "parameters": [ { "in": "query", "name": "globalUserId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/power-reviews-products": { "post": { "operationId": "createPowerReviewsProduct", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Product" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "422": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Product" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PowerReviewsProductRequestBody" } } ] }, "put": { "operationId": "editPowerReviewsProduct", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "422": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Product" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PowerReviewsProductRequestBody" } } ] } }, "/v1/products": { "get": { "operationId": "getProducts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_Product-Array_" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Products" ], "parameters": [ { "in": "query", "name": "title", "required": false, "type": "string" }, { "in": "query", "name": "powerReviewsAppId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/action-group-reports/products": { "get": { "operationId": "getProductsUsingToken", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_Product-Array_" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Products" ], "parameters": [ { "in": "query", "name": "title", "required": false, "type": "string" } ] } }, "/v2/public/campaigns/{id}": { "get": { "operationId": "getPublicCampaignById", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/Readonly_any_" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Bad Request", "schema": { "$ref": "#/definitions/UnprocessableContent" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "public", "campaigns" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/marketer-filter-preferences": { "get": { "operationId": "getMarketerFilterPreferences", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "items": { "$ref": "#/definitions/MarketerFiltersItem" }, "type": "array" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "MarketerFilterPreferences" ], "parameters": [ { "in": "query", "name": "communityId", "required": true, "type": "string" }, { "in": "query", "name": "s4AccountId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "setMarketerFilterPreferences", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "MarketerFilterPreferences" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/MarketerFilterPreferenceBody" } } ] } }, "/v1/reset-password": { "get": { "operationId": "getResetKey", "produces": [ "application/json" ], "responses": { "200": { "description": "Email Sent to Connected Account", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing/invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Authentication" ], "parameters": [ { "in": "query", "name": "email", "required": true, "type": "string" }, { "in": "query", "name": "hostname", "required": false, "type": "string" } ] }, "post": { "operationId": "resetPassword", "produces": [ "application/json" ], "responses": { "200": { "description": "Password Changed", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing/invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Authentication" ], "parameters": [ { "in": "body", "name": "requestBody", "required": true, "schema": { "$ref": "#/definitions/PostRequestBody" } } ] } }, "/v1/action-groups/review-form-responses/{communityId}": { "get": { "operationId": "ExportByCommunityIdAndCampaignId", "produces": [ "application/json" ], "responses": { "200": { "description": "Success", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ReviewFormResponse" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "query", "name": "campaignId", "required": false, "type": "string" } ] } }, "/v1/action-groups/{actionGroupId}/list-member-reward-wins/{globalUserId}": { "get": { "operationId": "getRewardWins", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetListMemberRewardWinResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ListMemberRewardWin" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "includeMostRecentTransaction", "required": false, "type": "boolean" } ] }, "post": { "operationId": "createRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ListMemberRewardWinResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ListMemberRewardWin" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "globalUserId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/ListMemberRewardWinRequestBody" } } ] } }, "/v1/reward-wins/fulfill-objects/bulk": { "put": { "operationId": "bulkFulfillRewardWinsObjects", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "rewardWinIds", "required": true, "schema": { "items": { "type": "number", "format": "double" }, "type": "array" } } ] } }, "/v1/reward-wins/fulfill-objects-with-params/bulk": { "put": { "operationId": "bulkFulfillRewardWinsObjectsWithParams", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "rewardWins", "required": true, "schema": { "items": { "$ref": "#/definitions/RewardWinBulkFulfillmentParams" }, "type": "array" } } ] } }, "/v1/reward-wins/unfulfill-objects/bulk": { "put": { "operationId": "bulkUnfulfillRewardWinsObjects", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "rewardWinIds", "required": true, "schema": { "items": { "type": "number", "format": "double" }, "type": "array" } } ] } }, "/v1/reward-wins/update-objects/bulk": { "put": { "operationId": "bulkUpdateRewardWinsObjects", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "items": { "$ref": "#/definitions/RewardWinBulkUpdateBody" }, "type": "array" } } ] } }, "/v1/reward-wins/unarchive-objects/bulk": { "put": { "operationId": "bulkUnarchiveRewardWinsObjects", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "rewardWinIds", "required": true, "schema": { "items": { "type": "number", "format": "double" }, "type": "array" } } ] } }, "/v1/reward-wins/update-filter/bulk": { "put": { "operationId": "bulkUpdateRewardWinsFilterValue", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/BulkUpdateWithFilterRequestBody" } } ] } }, "/v1/reward-wins/unarchive-filter/bulk": { "put": { "operationId": "bulkUnarchiveRewardWinsFilterValue", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BulkMetadata" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/BulkActionWithFilterRequestBody" } } ] } }, "/v1/reward-wins": { "get": { "operationId": "getAllRewardWins", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetRewardWinsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "query", "name": "fulfillmentStatus", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "isArchived", "required": false, "type": "boolean" }, { "in": "query", "name": "userFilterData", "required": false, "type": "string" }, { "in": "query", "name": "type", "required": false, "type": "string", "enum": [ "STRIPE", "PAYPAL", "MAVELY", "TIPALTI", "TANGO_CARDS", "MANUAL_CASH_PAYMENT", "MANUAL_GIFT_CARD", "SHOPIFY_DISCOUNT", "PRODUCT", "PROMO_CODE", "OTHER", "GIFT_CARD" ] }, { "in": "query", "name": "q", "required": false, "type": "string" }, { "in": "query", "name": "excludedRewardWinIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "includedRewardWinIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "actionGroupId", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "daysReady", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "globalUserIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderField", "required": false, "type": "string" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, { "in": "query", "name": "includeListMember", "required": false, "type": "boolean" } ] } }, "/v1/reward-wins/{id}": { "put": { "operationId": "updateRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetRewardWin" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "data", "required": true, "schema": { "type": "object" } } ] } }, "/v1/reward-wins/{id}/fulfillment": { "put": { "operationId": "fulfillRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "Fulfillment successful", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": false, "schema": { "$ref": "#/definitions/RewardWinFulfillmentParams" } } ] } }, "/v1/reward-wins/{id}/unfulfillment": { "put": { "operationId": "unfulfillRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "Fulfillment successful", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/reward-wins/{id}/reversal": { "put": { "operationId": "reverseRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "Reversal successful" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/reward-wins/{id}/void-payment": { "post": { "operationId": "voidTipaltiPayment", "produces": [ "application/json" ], "responses": { "200": { "description": "Payment voided", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/reward-wins/{id}/unarchival": { "put": { "operationId": "unarchiveRewardWin", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/reward-wins/dashboard/summary": { "get": { "operationId": "getSummary", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetSummaryResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Resource Not Found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "RewardWins" ], "parameters": [ { "in": "query", "name": "fulfillmentStatus", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "string" } }, { "in": "query", "name": "isArchived", "required": false, "type": "boolean" }, { "in": "query", "name": "userFilterData", "required": false, "type": "string" }, { "in": "query", "name": "type", "required": false, "type": "string" }, { "in": "query", "name": "q", "required": false, "type": "string" }, { "in": "query", "name": "excludedRewardWinIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "includedRewardWinIds", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "actionGroupId", "required": false, "collectionFormat": "multi", "type": "array", "items": { "type": "number", "format": "double" } }, { "in": "query", "name": "daysReady", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "orderField", "required": false, "type": "string" }, { "in": "query", "name": "orderDirection", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] } ] } }, "/v1/s4-instance-branding": { "get": { "operationId": "getInstanceBranding", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/S4instanceBrandingResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Instances" ], "parameters": [ { "in": "query", "name": "hostname", "required": false, "type": "string" }, { "in": "query", "name": "brandingId", "required": false, "type": "string" } ] } }, "/v1/s4-instance-branding/{brandingId}": { "post": { "operationId": "updateInstanceBranding", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/S4instanceBrandingResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Instances" ], "parameters": [ { "in": "path", "name": "brandingId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateInstanceBrandingBody" } } ] }, "delete": { "operationId": "deleteInstanceBranding", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Instances" ], "parameters": [ { "in": "path", "name": "brandingId", "required": true, "type": "string" } ] } }, "/v1/shareable-links/visitors": { "post": { "operationId": "createShareableLinksVisitor", "produces": [ "application/json" ], "responses": { "201": { "description": "Created" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShareableLinksVisitors" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateShareableLinksVisitorBody" } } ] }, "get": { "operationId": "getShareableLinksVisitors", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ShareableLinksVisitorsListResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShareableLinksVisitors" ], "parameters": [ { "in": "query", "name": "sharedCipherId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "communityId", "required": false, "type": "string" }, { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "dashboardType", "required": false, "type": "string" }, { "in": "query", "name": "fromDate", "required": false, "format": "date-time", "type": "string" }, { "in": "query", "name": "toDate", "required": false, "format": "date-time", "type": "string" } ] } }, "/v1/shared-ciphers": { "post": { "operationId": "encodeCipher", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SharedCipherPostResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "SharedCipher" ], "parameters": [ { "in": "body", "name": "sharedCipherPostBody", "required": true, "schema": { "$ref": "#/definitions/SharedCipherPostBody" } } ] }, "get": { "operationId": "queryCiphers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SharedCiphersGetResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SharedCipher" ], "parameters": [ { "in": "query", "name": "actionGroupId", "required": false, "format": "double", "type": "number" } ] } }, "/v1/shared-ciphers/{cipher}": { "get": { "operationId": "decodeCipher", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SharedCipherGetResponse" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "410": { "description": "Shared link expired", "schema": { "$ref": "#/definitions/SharedLinkExpiredError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SharedCipher" ], "parameters": [ { "in": "path", "name": "cipher", "required": true, "type": "string" } ] } }, "/v1/shared-ciphers/{id}/options": { "put": { "operationId": "updateOptions", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "SharedCipher" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SharedCipherPutBody" } } ] } }, "/v1/shopify-accounts": { "get": { "operationId": "getInstanceShopifyAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAccount" ], "parameters": [] }, "post": { "operationId": "createShopifyAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ShopifyAccountResponse" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShopifyAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateShopifyAccountData" } } ] } }, "/v1/shopify-accounts/uninstall": { "post": { "operationId": "uninstallShopifyAccount", "produces": [ "application/json" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShopifyAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UninstallShopifyRequest" } } ] } }, "/v1/shopify-accounts/install": { "get": { "operationId": "shopifyInstall", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAccount" ], "parameters": [] } }, "/v1/shopify-accounts/auth": { "get": { "operationId": "shopifyAuth", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAccount" ], "parameters": [] } }, "/v1/shopify-accounts/connect": { "post": { "operationId": "connectShopifyApp", "produces": [ "application/json" ], "responses": { "201": { "description": "Created", "schema": { "additionalProperties": true } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShopifyAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ConnectShopifyAccountBody" } } ] } }, "/v1/shopify-accounts/webhooks/uninstall": { "post": { "operationId": "uninstallShopifyApp", "produces": [ "application/json" ], "responses": { "204": { "description": "No content" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShopifyAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "type": "object" } } ] } }, "/v1/shopify-accounts/webhooks/compliance/shop/redact": { "post": { "operationId": "shopRedact", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "ShopifyAccount" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "type": "object" } } ] } }, "/v1/shopify-accounts/webhooks/compliance/customers/redact": { "post": { "operationId": "customerRedact", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAccount" ], "parameters": [] } }, "/v1/shopify-accounts/webhooks/compliance/customers/data_request": { "post": { "operationId": "customerDataRequest", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAccount" ], "parameters": [] } }, "/v1/shopify/{discountRedeemCode}/order-details": { "get": { "operationId": "getOrderDetailsByDiscountCode", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "string" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAdminApi" ], "parameters": [ { "in": "path", "name": "discountRedeemCode", "required": true, "type": "string" } ] } }, "/v1/shopify/{discountCodeNodeId}": { "get": { "operationId": "getDiscount", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "ShopifyAdminApi" ], "parameters": [ { "in": "path", "name": "discountCodeNodeId", "required": true, "type": "string" } ] } }, "/v1/slow-migration/{username}": { "get": { "operationId": "getUser", "produces": [ "application/json" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/SlowMigrationGetResponse" } }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AdministrationAccountSlowMigration" ], "parameters": [ { "in": "path", "name": "username", "required": true, "type": "string" } ] }, "post": { "operationId": "validatePassword", "produces": [ "application/json" ], "responses": { "200": { "description": "" }, "400": { "description": "Invalid Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Action group not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "AdministrationAccountSlowMigration" ], "parameters": [ { "in": "path", "name": "username", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ValidatePasswordBody" } } ] } }, "/v1/snapchat-content-refresh-jobs": { "post": { "operationId": "triggerSnapchatContentRefreshJob", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SnapchatContent" ], "parameters": [] } }, "/v1/snapchat-content-refresh-jobs/{creatorProfileId}": { "post": { "operationId": "refreshContentForProfile", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/RefreshSnapchatContentResponse" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SnapchatContent" ], "parameters": [ { "in": "path", "name": "creatorProfileId", "required": true, "type": "string" } ] } }, "/v1/subscribers": { "get": { "operationId": "getSubscribers", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Subscriber" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Subscribers" ], "parameters": [] }, "post": { "operationId": "createSubscriber", "produces": [ "application/json" ], "responses": { "201": { "description": "OK", "schema": { "$ref": "#/definitions/Subscriber" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Subscribers" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateSubscriberBody" } } ] } }, "/v1/subscribers/{id}": { "put": { "operationId": "updateSubscriber", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Subscribers" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateSubscriberBody" } } ] } }, "/v1/subscribers/{id}/ping": { "get": { "operationId": "pingSubscriber", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SubscriberPingResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Subscribers" ], "parameters": [ { "in": "path", "name": "id", "required": true, "type": "string" } ] } }, "/v1/action-groups/{actionGroupId}/survey-response-summary": { "get": { "operationId": "getSurveySummaries", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/SurveyResponseSummary" }, "type": "array" } }, "required": [ "data" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SurveyResponse" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{actionGroupId}/survey-responses": { "get": { "operationId": "getSurveyResponses", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "data": { "items": { "$ref": "#/definitions/SurveyResponse" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMetadata" } }, "required": [ "data", "meta" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "SurveyResponse" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/action/{actionId}/survey": { "get": { "operationId": "getSurveyByActionId", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetSurveyByActionIdResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "No survey found for this action id", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Surveys" ], "parameters": [ { "in": "path", "name": "actionId", "required": true, "type": "string" } ] } }, "/v1/tiktok-campaigns/{actionGroupId}": { "get": { "operationId": "getTikTokCampaignFields", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/TikTokCampaignOrBrandInfoFieldsResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TikTokCampaignFields" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "upsertTikTokCampaignFields", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/TikTokCampaignOrBrandInfoFieldsResponse" } }, "400": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/BadRequestError" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "TikTokCampaignFields" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/CreateTikTokCampaignFieldsOrBrandInfoBody" } } ] } }, "/v1/tiktok-activations/{tiktokMediaId}": { "put": { "operationId": "Put", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "additionalProperties": true } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "422": { "description": "Validation Failed", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "tiktokMediaId", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/PutTikTokContentActivationRequestBody" } } ] } }, "/v1/influencer-topics": { "get": { "operationId": "getInfluencerTopics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_TopicIdSet_" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "InfluencerTopics" ], "parameters": [] }, "put": { "operationId": "setInfluencerTopics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Invalid or missing parameter.", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Global user or resource not found.", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error.", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "InfluencerTopics" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/TopicIdSet" } } ] } }, "/v1/topics": { "get": { "operationId": "getTopics", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetTopicsResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Topics" ], "parameters": [ { "in": "query", "name": "orderBy", "required": false, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "labelParam", "required": false, "type": "string" } ] } }, "/v1/action-groups/{id}/tracking-links": { "get": { "operationId": "getTrackingLinks", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TrackingLinksGetResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TrackingLinks" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "query", "name": "globalUserId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/action-groups/{id}/tracking-links/{trackingLinkId}": { "put": { "operationId": "updateTrackingLink", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/ConflictError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "TrackingLinks" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "trackingLinkId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/EditTrackingLinkBody" } } ] }, "delete": { "operationId": "deleteTrackingLink", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "409": { "description": "Conflict", "schema": { "$ref": "#/definitions/ConflictError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TrackingLinks" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "path", "name": "trackingLinkId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/translations/fetch-available-locales": { "get": { "operationId": "fetchAvailableLocales", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "items": { "$ref": "#/definitions/Locale" }, "type": "array" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Translations" ], "parameters": [] } }, "/v1/ttcm/management/queues/purge": { "post": { "operationId": "purgeTikTokQueue", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue purged", "schema": { "$ref": "#/definitions/Components.Schemas.PurgeQueueResponse" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TikTok TTCM" ], "parameters": [ { "in": "query", "name": "queue", "required": true, "type": "string", "enum": [ "media-binder", "media-updater", "creator-updater" ] } ] } }, "/v1/ttcm/management/queues/stats": { "get": { "operationId": "getTikTokQueueStats", "produces": [ "application/json" ], "responses": { "200": { "description": "Queue stats returned", "schema": { "$ref": "#/definitions/Components.Schemas.QueueStatsResponse" } }, "400": { "description": "Validation Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "TikTok TTCM" ], "parameters": [] } }, "/v1/url-metadata": { "get": { "operationId": "getURLMetadata", "produces": [ "application/json" ], "responses": { "200": { "description": "URL metadata", "schema": { "type": "object" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "URL invalid or inaccessible", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "URLMetadata" ], "parameters": [ { "in": "query", "name": "url", "required": true, "type": "string" }, { "in": "query", "name": "s3Upload", "required": false, "type": "boolean" }, { "in": "query", "name": "s3Directory", "required": false, "type": "string" } ] } }, "/v1/account-invitations": { "get": { "operationId": "getAccountInvitations", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_AccountInvitationDomain-Array_" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AccountInvitations" ], "parameters": [ { "in": "query", "name": "communityId", "required": true, "type": "string" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] }, "post": { "operationId": "postAccountInvitation", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountInvitationDomain" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "AccountInvitations" ], "parameters": [ { "in": "body", "name": "requestBody", "required": true, "schema": { "$ref": "#/definitions/AccountActivationPostRequestBody" } } ] } }, "/v1/account-invitations/{id}": { "put": { "operationId": "putAccountInvitation", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountInvitationDomain" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "AccountInvitations" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "requestBody", "required": true, "schema": { "$ref": "#/definitions/AccountActivationPutRequestBody" } } ] }, "delete": { "operationId": "deleteAccountInvitation", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AccountInvitations" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/account-invitations/{id}/refresh": { "post": { "operationId": "refreshAccountInvitation", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/AccountInvitationDomain" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AccountInvitations" ], "parameters": [ { "in": "path", "name": "id", "required": true, "format": "double", "type": "number" } ] } }, "/v1/account-invitations/accept": { "get": { "operationId": "acceptAccountInvitation", "produces": [ "application/json" ], "responses": { "302": { "description": "Redirect" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AccountInvitations" ], "parameters": [ { "in": "query", "name": "signature", "required": true, "type": "string" } ] } }, "/v1/account-invitations/post-registration": { "get": { "operationId": "postRegistration", "produces": [ "application/json" ], "responses": { "302": { "description": "Redirect" }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AccountInvitations" ], "parameters": [ { "in": "query", "name": "signature", "required": true, "type": "string" } ] } }, "/v1/administrator_accounts": { "get": { "operationId": "getAdministratorAccounts", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ResponseBody_AdministratorAccount-Array_" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AdministratorAccounts" ], "parameters": [ { "in": "query", "name": "email", "required": false, "type": "string" }, { "in": "query", "name": "communityId", "required": false, "type": "string" }, { "in": "query", "name": "excludeRootAccounts", "required": false, "type": "boolean" }, { "in": "query", "name": "limit", "required": false, "format": "double", "type": "number" }, { "in": "query", "name": "offset", "required": false, "format": "double", "type": "number" } ] } }, "/v1/administrator_accounts/{username}": { "get": { "operationId": "getAdministratorAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/AdministratorAccountGetResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "AdministratorAccounts" ], "parameters": [ { "in": "path", "name": "username", "required": true, "type": "string" } ] }, "post": { "operationId": "validateAdministratorAccount", "produces": [ "application/json" ], "responses": { "200": { "description": "" }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "AdministratorAccounts" ], "parameters": [ { "in": "path", "name": "username", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/ValidatePasswordBody" } } ] } }, "/v1/communities/{communityId}/accounts/{accountId}": { "get": { "operationId": "getUserInCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunityAdministratorAccount" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Communities" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "path", "name": "accountId", "required": true, "type": "string" } ] }, "put": { "operationId": "updateUserRoleInCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Communities" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "path", "name": "accountId", "required": true, "type": "string" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/UpdateAccountPutBody" } } ] }, "delete": { "operationId": "removeAccountFromCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TSOAEmptyObject" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Communities" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "path", "name": "accountId", "required": true, "type": "string" } ] } }, "/v1/communities/{communityId}/accounts": { "post": { "operationId": "addAccountToCommunity", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdObject" } }, "400": { "description": "Error", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Error", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Error", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Communities" ], "parameters": [ { "in": "path", "name": "communityId", "required": true, "type": "string" }, { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/AddToCommunityPostBody" } } ] } }, "/v1/global-users-merge/search": { "post": { "operationId": "getGlobalUserMerges", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "targetGlobalUserId": { "type": "number", "format": "double" }, "sourceGlobalUserId": { "type": "number", "format": "double" }, "sequence": { "items": { "type": "number", "format": "double" }, "type": "array" }, "merges": { "items": { "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "toId": { "type": "number", "format": "double" }, "status": { "type": "string" }, "source": { "type": "string" }, "results": { "additionalProperties": true }, "id": { "type": "number", "format": "double" }, "fromId": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "updatedAt", "toId", "status", "source", "results", "id", "fromId", "createdAt" ], "type": "object" }, "type": "array" }, "error": { "type": "string" } }, "required": [ "targetGlobalUserId", "sourceGlobalUserId", "sequence", "merges" ], "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUserMerge" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/GlobalUserMergeSearchRequest" } } ] } }, "/v1/global-users-merge": { "post": { "operationId": "globalUserMerge", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "GlobalUserMerge" ], "parameters": [ { "in": "body", "name": "data", "required": true, "schema": { "$ref": "#/definitions/GlobalUserMergeRequest" } } ] } }, "/v1/global-users-total": { "get": { "operationId": "getQueryTotal", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" } }, "required": [ "meta" ], "type": "object" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "GlobalUser" ], "parameters": [] } }, "/v1/conversion-pinger": { "post": { "operationId": "createConversion", "produces": [ "application/json" ], "responses": { "200": { "description": "Posted a new conversion", "schema": { "$ref": "#/definitions/ResponseBody_WebPluginConversionResponse-Array_" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Community and/or its conversion tag not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Conversions" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/WebPluginConversionBody" } } ] } }, "/v1/web-plugin/widgets": { "get": { "operationId": "getWebPluginWidgets", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/GetWebPluginWidgetsResponse" } }, "400": { "description": "Invalid parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Invalid API Key", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "Form tied to action not found", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "WebPluginWidgets" ], "parameters": [ { "in": "query", "name": "communityId", "required": false, "type": "string" }, { "in": "query", "name": "initializationRuleType", "required": false, "type": "string" } ] } }, "/webhooks/sendgrid-events": { "post": { "operationId": "sendgridWebhookEvents", "produces": [ "application/json" ], "responses": { "200": { "description": "OK" }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "parameters": [ { "in": "query", "name": "token", "required": true, "type": "string" }, { "in": "body", "name": "body", "required": true, "schema": { "items": { "$ref": "#/definitions/SendGridEvent" }, "type": "array" } } ] } }, "/v1/yotpo-apps": { "get": { "operationId": "getYotpoApps", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "items": { "$ref": "#/definitions/YotpoAppResponse" }, "type": "array" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "Yotpo" ], "parameters": [] }, "post": { "operationId": "createYotpoApp", "produces": [ "application/json" ], "responses": { "200": { "description": "Ok", "schema": { "$ref": "#/definitions/YotpoAppResponse" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "404": { "description": "The resource does not exist", "schema": { "$ref": "#/definitions/NotFoundError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "Yotpo" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/YotpoAppPostRequest" } } ] } }, "/v1/ytbc/action-groups/{actionGroupId}/campaign-code": { "get": { "operationId": "getActionGroupCampaignCode", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupCampaignCodeResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "YtbcActionGroupChannels" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/ytbc/action-groups/{actionGroupId}/youtube-channel": { "get": { "operationId": "getActionGroupYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "YtbcActionGroupChannels" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "setActionGroupYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "YtbcActionGroupChannels" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SetYoutubeChannelRequest" } } ] }, "delete": { "operationId": "clearActionGroupYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ActionGroupYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "YtbcActionGroupChannels" ], "parameters": [ { "in": "path", "name": "actionGroupId", "required": true, "format": "double", "type": "number" } ] } }, "/v1/ytbc/brand-channels/validate": { "post": { "operationId": "validateBrandYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BrandChannelValidationResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "YtbcBrandChannels" ], "parameters": [ { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/BrandChannelValidationRequest" } } ] } }, "/v1/ytbc/brands/{brandId}/youtube-channel": { "get": { "operationId": "getBrandYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BrandYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "YtbcBrandChannels" ], "parameters": [ { "in": "path", "name": "brandId", "required": true, "format": "double", "type": "number" } ] }, "put": { "operationId": "setBrandYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BrandYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "consumes": [ "application/json" ], "tags": [ "YtbcBrandChannels" ], "parameters": [ { "in": "path", "name": "brandId", "required": true, "format": "double", "type": "number" }, { "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/SetYoutubeChannelRequest" } } ] }, "delete": { "operationId": "clearBrandYoutubeChannel", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/BrandYoutubeChannelResponse" } }, "400": { "description": "Missing Parameter", "schema": { "$ref": "#/definitions/ValidateErrorJSON" } }, "403": { "description": "Access forbidden", "schema": { "$ref": "#/definitions/ForbiddenError" } }, "500": { "description": "Server Error", "schema": { "$ref": "#/definitions/ServerError" } } }, "tags": [ "YtbcBrandChannels" ], "parameters": [ { "in": "path", "name": "brandId", "required": true, "format": "double", "type": "number" } ] } } }, "basePath": "/v1", "host": "app.splashscore.com", "schemes": [ "http", "https" ], "produces": [ "application/json" ], "parameters": { "OutboundMessage": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "html", "subject", "recipients" ], "properties": { "recipients": { "type": "array", "items": { "$ref": "#/definitions/MessageRecipient" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "templates": { "type": "array", "items": { "$ref": "#/definitions/ConversationTemplateDeprecated" } }, "subject": { "type": "string" }, "html": { "type": "string" } } } }, "ReferralActionData": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "url": { "type": "string" }, "membershipId": { "type": "number" } } } }, "approvalStatus": { "in": "query", "type": "string", "description": "The approval status of an Activation.", "name": "approvalStatus" }, "limitParam": { "in": "query", "type": "integer", "description": "Maximum number of items to return", "name": "limit" }, "offsetParam": { "in": "query", "type": "integer", "description": "Number of items to skip", "name": "offset" }, "orderByParam": { "in": "query", "type": "string", "description": "Attribute to order by.", "name": "orderBy" }, "cipherParam": { "in": "query", "type": "string", "description": "Encoded cipher.", "name": "cipher" }, "postsWithUGC": { "in": "query", "type": "boolean", "description": "Specifies whether to get UGC and require an Activation Content Summary or not.", "name": "postsWithUGC" }, "networkParam": { "in": "query", "type": "string", "description": "Specifies the network of an Activation.", "name": "network" }, "nameHandleOrEmailParam": { "in": "query", "type": "string", "description": "Will apply a where filter to the name, handle or email of an influencer.", "name": "nameHandleOrEmail" }, "q": { "in": "query", "type": "string", "description": "Search parameter.", "name": "q" }, "channel": { "in": "query", "type": "string", "description": "Allows the client to indicate their channel, in order to filter irrelevant resources.", "name": "channel" }, "userFilter": { "in": "query", "type": "string", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition.", "name": "userFilter" }, "orderDirection": { "in": "query", "type": "string", "enum": [ "ASC", "DESC" ], "description": "Select the direction by which the data will be ordered, ascending or descending.", "name": "orderDirection" }, "searchKeywords": { "in": "query", "type": "string", "description": "Search keyword chips to specify search intent. JSON-stringified array of strings.", "name": "searchKeywords" }, "labelParam": { "name": "label", "in": "query", "required": false, "type": "string" }, "listStatusId": { "name": "statusId", "in": "query", "required": false, "type": "array", "items": { "type": "integer" } }, "listCustomStatusId": { "name": "customStatusId", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, "listCustomInfluencerStatusId": { "name": "customInfluencerStatusId", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, "contentDueDate": { "name": "dueDate", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, "hasCompletedActivity": { "name": "completed", "in": "query", "required": false, "type": "boolean" }, "hasOptedInToActivity": { "name": "optedIn", "in": "query", "required": false, "type": "integer" }, "isParticipatingInActivity": { "name": "participating", "in": "query", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "csv" }, "options": { "name": "options", "in": "query", "type": "string", "required": false }, "retrieveIds": { "in": "query", "type": "boolean", "description": "Retrieve list of global user IDs.", "name": "retrieveIds" }, "globalUserIds": { "name": "globalUserIds", "in": "query", "required": false, "type": "array", "items": { "type": "integer" }, "collectionFormat": "csv" }, "useSearchWithOpenAI": { "name": "useSearchWithOpenAI", "in": "query", "required": false, "type": "boolean" }, "openAISearchResults": { "name": "openAISearchResults", "in": "query", "required": false, "type": "string" }, "Activation": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "content" ], "properties": { "id": { "type": "integer" }, "isApproved": { "type": "boolean" }, "selfReported": { "type": "boolean" }, "content": { "type": "object", "properties": { "likes": { "type": "integer" }, "comments": { "type": "integer" }, "shares": { "type": "integer" }, "clicks": { "type": "integer" }, "estimatedImpressions": { "type": "integer" }, "conversions": { "type": "integer" }, "conversionValue": { "type": "number" }, "network": { "type": "string" }, "image": { "type": "string" }, "video": { "type": "string" }, "text": { "type": "string" }, "privacy": { "type": "string" }, "postLink": { "type": "string" }, "views": { "type": "number" }, "mediaUpload": { "type": "array", "items": { "type": "object", "properties": { "fileUrl": { "type": "string" }, "caption": { "type": "string" } } } } } }, "associatedAccount": { "$ref": "#/definitions/NetworkAccountDeprecated" } } } }, "InfluencerContractCampaignTemplate": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "campaignId", "template" ], "properties": { "id": { "type": "integer", "description": "Unique integer identifying a single campaign-level influencer contract template." }, "campaignId": { "type": "integer", "description": "Unique integer identifying a single action group, referred to as a campaign client-side." }, "template": { "type": "string", "description": "Campaign-level influencer contract template." } } } }, "InfluencerContractCommunityTemplate": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "template" ], "properties": { "id": { "type": "integer", "description": "Unique integer identifying a single community-level influencer contract template." }, "template": { "type": "string", "description": "Community-level influencer contract template." } } } }, "ListMemberRewardWin": { "name": "data", "in": "body", "required": true, "schema": { "type": "object", "required": [ "eligibleOnEventType", "RewardWin" ], "properties": { "eligibleOnEventType": { "type": "string", "enum": [ "MANUAL", "ACCEPTANCE", "COMPLETION", "PENDING_SHIPMENT", "PENDING_PAYMENT" ] }, "globalUserId": { "type": "integer" }, "RewardWin": { "type": "object", "required": [ "cost", "value", "type", "rewardTitle" ], "properties": { "id": { "type": "integer" }, "cost": { "type": "number" }, "value": { "type": "number" }, "rewardTitle": { "type": "string" }, "type": { "type": "string", "enum": [ "CASH", "PRODUCT", "OTHER", "GIFT_CARD", "PROMO_CODE" ] }, "description": { "type": "string" }, "comment": { "type": "string" }, "fulfillmentStatus": { "type": "string", "enum": [ "DRAFT", "REJECTED", "PENDING", "READY" ] } } } } } } }, "definitions": { "GlobalUserList": { "type": "object", "required": [ "label" ], "properties": { "id": { "type": "integer" }, "label": { "type": "string", "minLength": 1, "maxLength": 50 }, "createdAt": { "type": "string", "format": "date-time" } } }, "CommunityMetric": { "type": "object", "properties": { "metricId": { "type": "integer" }, "enabled": { "type": "boolean" }, "metric": { "$ref": "#/definitions/Metric" } } }, "PendingActivationURI": { "type": "object", "properties": { "id": { "type": "integer" } } }, "ZendeskArticle": { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the help center article." }, "body": { "type": "string", "description": "HTML of the article" } } }, "BrandDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for a brand." }, "name": { "type": "string", "description": "Name of the brand." }, "logo": { "type": "string" }, "accentColor": { "type": "string" }, "buttonColor": { "type": "string" }, "associatedWithCampaign": { "type": "boolean", "description": "A flag indicating whether this brand has been associated with a campaign. If this is true, then this brand cannot be deleted." } } }, "TopicIdSetDeprecated": { "type": "object", "properties": { "topicIds": { "type": "array", "items": { "type": "string" } } } }, "TopicDeprecated": { "type": "object", "properties": { "id": { "type": "string", "description": "The topic ID" }, "name": { "type": "string", "description": "The topic name" }, "slug": { "type": "string" } } }, "AdministratorAccountsDeprecated": { "type": "object", "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "communityId": { "type": "string" }, "id": { "type": "string" }, "image": { "type": "string" }, "roles": { "type": "array", "items": { "$ref": "#/definitions/RoleDeprecated" } } } }, "Community": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "logo": { "type": "string" }, "retired": { "type": "boolean" } } }, "RoleDeprecated": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "IncentiveWinner": { "type": "object", "required": [ "id", "isDisqualified" ], "properties": { "id": { "type": "integer", "description": "Unique identifier for an incentive win." }, "winnerGlobalUserId": { "type": "integer" }, "winnerMembershipId": { "type": "integer" }, "winnerProfilePictureLink": { "type": "string" }, "winnerFirstName": { "type": "string" }, "winnerLastName": { "type": "string" }, "winnerEmail": { "type": "string" }, "winnerAddress": { "type": "string" }, "winnerAge": { "type": "integer" }, "winnerGender": { "type": "string" }, "winnerFacebookFriendCount": { "type": "integer", "description": "The friend count of the winner's Facebook account, provided to help identify and disqualify fake profiles." }, "winnerLastRewardWonTitle": { "type": "string", "description": "If this influencer has had one or more rewards fulfilled in the past, this gives the title of the reward most recently fulfilled." }, "winnerLastRewardFulfilledAt": { "type": "string", "format": "date-time", "description": "If this influencer has had one or more rewards fulfilled in the past, this gives the date & time in which the most recent fulfillment occurred." }, "isDisqualified": { "type": "boolean", "description": "Indicates whether this incentive winner has been disqualified." }, "disqualificationReason": { "type": "string", "description": "If a incentive winner has been disqualified, this is the reason why the disqualification occurred." }, "rewardIsFulfilled": { "type": "boolean", "description": "Indicates whether the reward win has been fulfilled. An incentive winner cannot be disqualified if his/her reward has already been fulfilled." } } }, "FacebookConnectionInfo": { "$ref": "#/definitions/FacebookProfileDeprecated" }, "PinterestConnectionInfo": { "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the Pinterest connection flow." }, "handle": { "type": "string", "description": "Client's Pinterest account handle" }, "profilePicture": { "type": "string", "description": "Client's Pinterest profile picture" } } }, "InstagramConnectionInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "Instagram Profile Id" }, "primaryAccount": { "type": "boolean" }, "expiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the either reconnection flow." }, "platformExpiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the Instagram Platform connection flow." }, "businessExpiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the Instagram Business connection flow." }, "handle": { "type": "string", "description": "Client's Instagram account handle" }, "profilePicture": { "type": "string", "description": "Client's Instagram profile picture" } } }, "TwitterConnectionInfoDeprecated": { "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the Twitter connection flow." }, "handle": { "type": "string", "description": "Client's Twitter account handle" }, "profilePicture": { "type": "string", "description": "Client's Twitter profile picture" } } }, "TikTokConnectionInfo": { "type": "object", "properties": { "primaryAccount": { "type": "boolean" }, "expiresAt": { "type": "string", "format": "date-time", "description": "The date by which the client should re-prompt the TikTok connection flow." }, "handle": { "type": "string", "description": "Client's TikTok account handle" }, "profilePicture": { "type": "string", "description": "Client's TikTok profile picture" } } }, "InfluencerPreview": { "type": "object", "properties": { "id": { "type": "integer" }, "globalUserId": { "type": "integer" }, "profilePic": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" } } }, "ResponseMetadataDeprecated": { "type": "object", "properties": { "totalCount": { "type": "integer", "description": "The total count of elements identified by the request, independent of pagination." }, "limit": { "type": "integer", "description": "The maximum number of elements returned." }, "offset": { "type": "integer", "description": "The number of elements elements skipped prior to the first in the response." }, "status": { "type": "string", "enum": [ "failure", "success" ] } } }, "AdministratorDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": [ "string", "null" ] }, "image": { "type": [ "string", "null" ] }, "approves": { "type": "boolean" }, "createdAt": { "format": "date-time", "type": "string", "description": "The date and time that the assessment was created." } } }, "InfluencerDataPointCriteriaDeprecated": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string" }, "value": { "type": [ "string", "boolean", "integer" ] }, "values": { "type": "array", "items": { "type": "string" } }, "minValue": { "type": "integer" }, "maxValue": { "type": "integer" } } }, "Profile": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "emailIsVerified": { "type": "boolean" }, "facebookExternalId": { "type": "string" }, "membershipId": { "type": "integer" }, "globalUserId": { "type": "integer" }, "isNewMember": { "type": "boolean" }, "location": { "type": "string" }, "becameMemberAt": { "type": "string", "format": "date-time" }, "connectedAccounts": { "type": "object", "properties": { "facebook": { "$ref": "#/definitions/FacebookConnectionInfo" }, "twitter": { "$ref": "#/definitions/TwitterConnectionInfoDeprecated" }, "instagram": { "$ref": "#/definitions/InstagramConnectionInfo" }, "pinterest": { "$ref": "#/definitions/PinterestConnectionInfo" }, "blog": { "$ref": "#/definitions/Blog" }, "emailAccounts": { "type": "array", "items": { "$ref": "#/definitions/EmailAccount" } }, "tiktok": { "$ref": "#/definitions/TikTokConnectionInfo" } } }, "connectedAccountsCollection": { "type": "object", "properties": { "facebook": { "type": "array", "items": { "$ref": "#/definitions/FacebookConnectionInfo" } }, "instagram": { "type": "array", "items": { "$ref": "#/definitions/InstagramConnectionInfo" } }, "tiktok": { "type": "array", "items": { "$ref": "#/definitions/TikTokConnectionInfo" } } } }, "referralSlug": { "type": "string" }, "referralCount": { "type": "integer" }, "loginCredentialsExist": { "type": "boolean" }, "memberSelectedEthnicities": { "type": "array", "items": { "type": "object", "properties": { "ethnicGroup": { "type": "string" }, "ethnicGroupDescription": { "type": "string" } } } } } }, "ActivationURI": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing the activation." }, "incentive": { "$ref": "#/definitions/IncentiveDeprecated" }, "points": { "type": "number", "description": "The number of points earned after activating." } } }, "IncentiveDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single incentive." }, "incentiveTitle": { "type": "string", "description": "Short, human-readable description of the incentive displayed for influencers." }, "incentiveDescription": { "type": "string", "description": "An elaboration on the title." }, "image": { "type": "string", "description": "Image to associate with the incentive." }, "quantity": { "type": "integer", "description": "The number of incentives left to claim." }, "sweepstakesWinnersQty": { "type": "integer", "description": "The number of winners for sweepstakes.", "x-access": [ "administrator" ] }, "type": { "type": "string", "description": "Incentive type." }, "rewardWinType": { "type": "string", "description": "Reward Win type of this incentive." }, "sweepstakesUrl": { "type": "string", "description": "Sweepstakes Terms link." }, "sweepsRules": { "type": "string", "description": "Toggle on whether a sweepstakes or contest rules are in a link or an uploaded PDF." }, "promocode": { "type": "string", "description": "The static promo code given to distribute to influencers.", "x-access": [ "administrator" ] }, "multipleClaims": { "type": "boolean", "description": "Whether this incentive allows for multiple claims." }, "promocodeTermsAndConditions": { "type": "string", "description": "Promocode terms and conditions." }, "exclusiveLinkUrl": { "type": "string", "description": "Url where Influencer can claim incentive." }, "exclusiveLinkCta": { "type": "string", "description": "Button copy to be displayed for Influencer" }, "contestMetric": { "type": "string", "description": "For contest type incentives, this determines the metric in which winners are selection (clickCount, conversionCount, or engagementCount)." }, "printableCoupon": { "type": "string", "description": "Printable coupon URL" }, "rewardId": { "type": "string", "description": "Generated unique identifier of a reward." }, "winnerSelectionMethod": { "type": "string", "x-access": [ "administrator", "root" ], "description": "Selection method used for influencer winners." }, "winnersSelectedCount": { "type": "integer", "x-access": [ "administrator", "root" ], "description": "For incentives tied to expired action groups, this indicates the number of winners that have already been selected." }, "disqualifiedWinnersCount": { "type": "integer", "x-access": [ "administrator", "root" ], "description": "For incentives tied to expired action groups, this indicates the number of winners that have been disqualified." }, "allocatedWinnersCount": { "type": "integer", "x-access": [ "administrator", "root" ], "description": "For incentives tied to expired action groups, this indicates the number of winners that were allocated to this incentive." }, "claimedIncentivesInfluencerCount": { "type": "integer", "x-access": [ "administrator", "root" ], "description": "This indicates the number of influencers that claimed this incentive." }, "claimedIncentivesCount": { "type": "integer", "x-access": [ "administrator", "root" ], "description": "This indicates the number of claims on this incentive." }, "actionGroupId": { "type": "integer", "description": "ID of the parent action group." }, "cashPaymentAppId": { "type": "integer", "description": "ID the associated cash payment app." }, "giftCardOptionId": { "type": "integer", "description": "ID the associated gift card option." }, "giftCardEmailTemplateId": { "type": "string", "description": "ID the associated gift card email template (External Id)." }, "actionGroupStatus": { "type": "string", "description": "Lifecycle status of the parent action group." }, "incentiveStatus": { "type": "string", "description": "Status of the incentive, which is relevant for non-activity incentives only." }, "claims": { "type": "array", "items": { "$ref": "#/definitions/IncentiveClaimDeprecated" } }, "endDate": { "format": "date-time", "type": [ "string", "null" ] }, "startDate": { "format": "date-time", "type": [ "string", "null" ] }, "unlockType": { "type": "string", "description": "Method of unlocking the incentive." }, "numberPointsRequired": { "type": "integer", "description": "For points unlocked incentives, the number of points requires to unlock this incentive." }, "approximateRetailValue": { "type": "number", "description": "The Approximate Retail Value of the incentive being rewarded.", "x-access": [ "administrator" ] }, "cost": { "type": "number", "description": "The Cost of the incentive being rewarded.", "x-access": [ "administrator" ] }, "costCurrencyCode": { "type": "string", "description": "Cost Currency Code.", "x-access": [ "administrator" ] }, "valueCurrencyCode": { "type": "string", "description": "Cost Currency Code.", "x-access": [ "administrator" ] }, "bonusTierCurrencyCode": { "type": [ "string", "null" ], "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", null ], "description": "Currency code used for all tiered bonus amounts. Required when `bonusTiers` is non-empty.", "x-access": [ "administrator" ] }, "bonusTiers": { "type": [ "array", "null" ], "description": "Tiered bonus payout ladder. Sorted, contiguous, at most 5 tiers, ending with one `OPEN_ENDED` tier.", "items": { "$ref": "#/definitions/BonusTier" }, "x-access": [ "administrator" ] }, "termsAndConditions": { "$ref": "#/definitions/IncentiveTermsAndConditionsDeprecated" }, "totalDynamicPromoCodes": { "type": "number", "description": "The total number of dynamic promo codes across all groups for this incentive", "x-access": [ "administrator" ] }, "claimedDynamicPromoCodes": { "type": "number", "description": "The number of claimed dynamic promo codes across all groups for this incentive", "x-access": [ "administrator" ] }, "unlockEvent": { "type": "string", "enum": [ "completion", "acceptance", "pending_shipment", "pending_payment" ] }, "cashPaymentAppProvider": { "type": "string", "description": "Cash Payment App Provider" }, "discountCodeId": { "type": "string", "description": "Discount code ID" }, "couponActivation": { "type": "string", "description": "Coupon Activation" } } }, "IncentiveClaimDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the incentive claim." }, "membershipId": { "type": "integer", "x-access": [ "administrator", "root" ] }, "globalUserId": { "type": "integer", "x-access": [ "administrator", "root" ] }, "promocode": { "type": "string", "description": "The issuance of a promo code. This is derived either from a static promo code configured as a property of the incentive resource or dynamically from a uploaded list of codes." }, "createdAt": { "format": "date-time", "type": "string" }, "profilePictureLink": { "type": "string", "x-access": [ "administrator", "root" ] }, "firstName": { "type": "string", "x-access": [ "administrator", "root" ] }, "lastName": { "type": "string", "x-access": [ "administrator", "root" ] }, "email": { "type": "string", "x-access": [ "administrator", "root" ] }, "address": { "type": "string", "x-access": [ "administrator", "root" ] }, "age": { "type": "integer", "x-access": [ "administrator", "root" ] }, "gender": { "type": "string", "x-access": [ "administrator", "root" ] }, "facebookFriendCount": { "type": "integer", "x-access": [ "administrator", "root" ] }, "mostRecentRewardFulfilledAt": { "type": "string", "format": "date-time", "x-access": [ "administrator", "root" ] }, "engagementCount": { "type": "integer" }, "clickCount": { "type": "integer" }, "conversionCount": { "type": "integer" } } }, "IncentiveTermsAndConditionsDeprecated": { "type": "object", "properties": { "template": { "x-access": [ "administrator", "root" ], "type": "string" }, "preview": { "type": "string" }, "params": { "x-access": [ "administrator", "root" ], "type": "object" } } }, "DataPointDefinitionSetElementDeprecated": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for the data point set element." }, "key": { "type": "string" }, "displayLabel": { "type": "string" }, "markUpDisplayLabel": { "type": "string" } } } }, "UserDataPoint": { "type": "object", "properties": { "key": { "type": "string", "description": "Key for the data point.", "x-access": [ "root", "administrator" ] }, "value": { "type": "array", "items": { "type": "string" }, "description": "Values of the data point for the given influencer user", "x-access": [ "root", "administrator" ] } } }, "ActionGroupURI": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing the action group created." } } }, "RoutingDeprecated": { "type": "object", "description": "Routing configuration.", "properties": { "success": { "$ref": "#/definitions/RoutingOptionsDeprecated" }, "not_eligible": { "$ref": "#/definitions/RoutingOptionsDeprecated" } } }, "RoutingOptionsDeprecated": { "type": "object", "description": "Routing options", "properties": { "redirect_url": { "type": "string", "description": "Url the influencer should be redirected to." }, "cta": { "type": "string", "description": "Displayed CTA." }, "mode": { "type": "string", "description": "Routing type." } } }, "LinksDeprecated": { "type": "object", "x-access": [ "anonymous", "influencer" ], "properties": { "normal": { "type": "string", "description": "A normal link to an entity." }, "deep": { "type": "string", "description": "A deep link to the entity." } } }, "MetaInformationDeprecated": { "type": "object", "description": "This information is pulled when an external network parses the link for meta tags.", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "ftcHashtag": { "type": "string" } } }, "PointGrantURI": { "type": "object", "required": [ "sourceId" ], "properties": { "sourceId": { "type": "integer", "description": "Unique identifier representing the source of the point granted." } } }, "PointTransaction": { "type": "object", "properties": { "sourceType": { "type": "string", "description": "The origination of the point transaction." }, "actionId": { "type": "integer", "description": "ID of associated action." }, "actionType": { "type": "string", "description": "Type of associated action." }, "pointGrantTime": { "type": "string", "format": "date", "description": "Datetime points were granted." }, "amount": { "type": "integer", "description": "Amount of points in this transaction." }, "activationId": { "type": "integer", "description": "Activation ID associated." }, "conversionDatapointId": { "type": "integer", "description": "Conversion data point id associated." }, "description": { "type": "string", "description": "A description provided for this points transaction e.g. action group name, incentive name, reason for manual entry." }, "incentiveClaimId": { "type": "integer", "description": "Incentive claim ID associated." } } }, "UserQuestionResponse": { "type": "object", "properties": { "id": { "type": "integer" }, "responseValue": { "type": "string" }, "responseType": { "type": "string" }, "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinitionDeprecated" } } }, "AudienceDeprecated": { "type": "object", "x-access": [ "root", "administrator" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single audience." }, "name": { "type": "string", "description": "Human-readable description of the audience displayed to administrators." }, "criteria": { "type": "array", "items": { "$ref": "#/definitions/InfluencerDataPointCriteriaDeprecated" } } } }, "EmptyObject": { "type": "object", "properties": {} }, "ActionURI": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier representing a single action." } } }, "Error": { "type": "object", "properties": { "type": { "type": "string", "description": "A key representing the type of error that has occurred." }, "error": { "type": "string", "description": "A static description of the type of error." }, "params": { "type": "array", "description": "For errors invovling parameters, this is an array containing the invalid parameters.", "items": { "type": "string" } }, "keys": { "type": "array", "items": { "type": [ "string", "object" ] } }, "artifactLinks": { "$ref": "#/definitions/LinksDeprecated" }, "parent": { "type": "object", "properties": { "type": { "type": "string", "description": "A key representing the type of error generated by a request to an external API." }, "error": { "type": "string", "description": "A static description of the parent error." } } } } }, "ReviewFormResponseDeprecated": { "type": "object", "properties": { "globalUserId": { "type": "integer" }, "membershipId": { "type": "integer", "description": "Unique Identifier for the membership" }, "rating": { "type": "integer", "description": "Review rating" }, "reviewCharacterCount": { "type": "integer", "description": "Sum of the character count in the review" }, "fullName": { "type": "string", "description": "Name of the influencer" }, "profilePic": { "type": "string", "description": "Profile picture of the influencer" }, "questionResponses": { "type": "array", "items": { "$ref": "#/definitions/QuestionResponseDeprecated" } }, "createdAt": { "type": "string", "format": "date-time" }, "reviewForm": { "$ref": "#/definitions/ReviewFormDeprecated" }, "product": { "$ref": "#/definitions/ProductDeprecated" } } }, "QuestionResponseDeprecated": { "type": "object", "properties": { "question": { "$ref": "#/definitions/QuestionDeprecated" }, "value": { "type": "string", "description": "review question value" } } }, "BazaarVoiceApp": { "type": "object", "properties": { "id": { "type": "integer", "description": "App Id" }, "apiKey": { "type": "string", "description": "Api Key" }, "environment": { "type": "string", "description": "Api Key Environment" }, "name": { "type": "string", "description": "Name of the App" } } }, "QuestionDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "The question ID" }, "key": { "type": "string", "description": "Unique key of the question" }, "type": { "type": "string", "description": "Indicates the HTML tag that is used to dynamically render this question." }, "className": { "type": "string", "description": "Additional classes for fields styling and formatting." }, "questionText": { "type": "string", "description": "The text of the question" }, "markUpQuestionText": { "type": "string", "description": "The text of the question with HTML markup" }, "questionResponses": { "x-access": [ "root", "administrator" ], "type": "array", "items": { "type": "object" } }, "maxResponses": { "type": "integer", "description": "Maximum length of responses allowed for this question." }, "hasResponses": { "x-access": [ "root", "administrator" ], "type": "boolean" }, "templateOptions": { "type": "object", "properties": { "type": { "type": "string", "description": "Indicates the data type to be submitted for this question in the form response." }, "label": { "type": "string", "description": "Human-readable label for the question." }, "placeholder": { "type": "string", "description": "Placeholder text to be display in the input field." }, "maxUploads": { "type": "integer", "description": "Maximum uploads for file upload questions" }, "accept": { "type": "string", "description": "The accepted file extension types for file upload questions" }, "required": { "type": "boolean", "description": "Required value for the question" }, "min": { "type": "integer", "description": "Minimum number allowed for a number type" }, "max": { "type": "integer", "description": "Maximum number allowed for a number type" }, "minlength": { "type": "integer", "description": "Minimum length of string allowed for a text type" }, "maxlength": { "type": "integer", "description": "Maximum length of string allowed for a text type" }, "options": { "type": "array", "description": "Array of possible options for a radio type", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Text to show for option" }, "value": { "type": "string", "description": "Key for option" } } } } } }, "dataPointDefinitionId": { "type": "integer", "description": "Use a data point definition to create a question.", "x-access": [ "administrator", "root" ] }, "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinitionDeprecated" }, "required": { "type": "boolean" }, "order": { "type": "integer" }, "hideFromInfluencers": { "type": "boolean" } } }, "ConversionTagDeprecated": { "type": "object", "x-access": [ "administrator", "root" ], "properties": { "id": { "type": "string", "description": "Unique identifier for the conversion tag." }, "name": { "type": "string", "description": "Human-readable name for the conversion tag." }, "code": { "type": "string", "description": "Code to embed in the Clickmeter JavaScript snippet to conduct conversion tracking." }, "type": { "type": "string", "description": "The category this conversion belongs. One of the set {\"purchase\", \"app_download\", \"sign_up\"}." }, "isActive": { "type": "boolean", "description": "Determines if a conversion tag is active or inactive" }, "isConversionValueEnabled": { "type": "boolean", "description": "Determines if a conversion tag is active or inactive" } } }, "ScheduledNotification": { "type": "object", "x-access": [ "administrator", "root" ], "properties": { "id": { "type": "integer" }, "sendTime": { "type": "string", "format": "date-time", "description": "Date to send notification" }, "notificationDefinitionKey": { "type": "string", "description": "The content " }, "notificationChannelPreview": { "type": "object", "description": "HTML templates of notification subject and body populated with sample data for preview.", "properties": { "subjectHTML": { "type": "string", "description": "Subject Line" }, "bodyHTML": { "type": "string", "description": "Body" } } }, "sent": { "type": "boolean" }, "isApproved": { "type": "boolean" }, "approvedBy": { "type": "integer", "description": "The account id of the user who approved this notification." }, "approvedByAccount": { "type": "string", "description": "The account email that approved the notification." }, "approvedAt": { "type": "string", "format": "date-time", "description": "Datetime notification was approved" }, "tags": { "description": "Editable templated properties", "type": "object" }, "audienceId": { "type": "integer" }, "audience": { "$ref": "#/definitions/AudienceDeprecated" }, "actionGroup": { "$ref": "#/definitions/ActionGroupDeprecated" } } }, "FacebookAccount": { "type": "object", "properties": { "name": { "type": "string" }, "link": { "type": "string" }, "picture": { "type": "string" }, "reach": { "type": "integer" }, "averageLikes": { "type": "integer" }, "averageComments": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" }, "type": { "type": "string" } } }, "InstagramProfileDeprecated": { "type": "object", "properties": { "accessGrant": { "type": "object", "properties": { "isExpired": { "type": "boolean" }, "type": { "type": "string", "enum": [ "basic", "business" ] } } }, "averageComments": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "averageLikes": { "type": "integer" }, "audienceFakeCommentersLevel": { "type": "string" }, "audienceFakeCommentersPercentage": { "type": "number" }, "audienceFakeEngagersLevel": { "type": "string" }, "audienceFakeFollowersLevel": { "type": "string" }, "audienceFakeFollowersPercentage": { "type": "number" }, "audienceFakeLikersLevel": { "type": "string" }, "audienceFakeLikersPercentage": { "type": "number" }, "audienceFraudLevel": { "type": "string" }, "audiencePercentageFemale": { "type": "number" }, "audiencePercentage_13_17": { "type": "number" }, "audiencePercentage_18_24": { "type": "number" }, "audiencePercentage_25_34": { "type": "number" }, "audiencePercentage_35_44": { "type": "number" }, "audiencePercentage_45_54": { "type": "number" }, "audiencePercentage_55_64": { "type": "number" }, "audiencePercentage_65_plus": { "type": "number" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "bio": { "type": "string" }, "boughtFollowers": { "type": "boolean" }, "engagementRate": { "type": "number" }, "id": { "type": "integer" }, "isBusiness": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "followersCount": { "type": "integer" }, "followingCount": { "type": "integer" }, "fullName": { "type": "string" }, "handle": { "type": "string" }, "mediaCount": { "type": "integer" }, "nudityLevel": { "type": "string" }, "profanityLevel": { "type": "string" }, "profilePicture": { "type": "string" }, "profileType": { "type": "string", "enum": [ "business", "platform" ] }, "sponsoredPostRate": { "type": "number" }, "website": { "type": "string" } } }, "InstagramAccountDeprecated": { "type": "object", "properties": { "id": { "description": "int = mavck-db-id, string = derived-index-id", "type": [ "integer", "string" ] }, "handle": { "type": "string" }, "fullName": { "type": "string" }, "profilePicture": { "type": "string" }, "bio": { "type": "string" }, "website": { "type": "string" }, "followersCount": { "type": "integer" }, "followingCount": { "type": "integer" }, "mediaCount": { "type": "integer" }, "averageLikes": { "type": "integer" }, "averageComments": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" }, "isBusiness": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "sponsoredPostRate": { "type": "number" }, "primaryAccount": { "type": "boolean" }, "profileType": { "type": "string", "enum": [ "platform", "business" ] }, "instagramAccessGrant": { "type": "object", "properties": { "isExpired": { "type": "boolean" }, "platformIsExpired": { "type": "boolean" }, "businessIsExpired": { "type": "boolean" } } } } }, "NetworkAccountDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "reach": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" } } }, "PinterestAccountDeprecated": { "type": "object", "properties": { "id": { "description": "int = mavck-db-id, string = derived-index-id", "type": [ "integer", "string" ] }, "username": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePicture": { "type": "string" }, "bio": { "type": "string" }, "followersCount": { "type": "integer" }, "followingCount": { "type": "integer" }, "monthlyViewers": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" }, "boardsCount": { "type": "integer" }, "pinsCount": { "type": "integer" }, "pinterestAccessGrant": { "type": "object", "properties": { "isExpired": { "type": "boolean" } } }, "primaryAccount": { "type": "boolean" } } }, "TwitterAccountDeprecated": { "type": "object", "properties": { "id": { "description": "int = mavck-db-id, string = derived-index-id", "type": [ "integer", "string" ] }, "handle": { "type": "string" }, "fullName": { "type": "string" }, "profilePicture": { "type": "string" }, "description": { "type": "string" }, "followersCount": { "type": "integer" }, "followingCount": { "type": "integer" }, "listedCount": { "type": "integer" }, "averageFavorites": { "type": "integer" }, "averageRetweets": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" }, "primaryAccount": { "type": "boolean" }, "twitterAccessGrant": { "type": "object", "properties": { "isExpired": { "type": "boolean" } } } } }, "YoutubeChannelDeprecated": { "type": "object", "properties": { "id": { "description": "int = mavck-db-id, string = derived-index-id", "type": [ "integer", "string" ] }, "username": { "type": "string" }, "bio": { "type": "string" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "followersCount": { "type": "integer" }, "youtubeExternalId": { "type": "string" }, "videoCount": { "type": "integer" }, "viewCount": { "type": "integer" }, "commentCount": { "type": "integer" }, "handle": { "type": "string" } } }, "ActionGroupCandidate": { "type": "object", "properties": { "user": { "$ref": "#/definitions/GlobalUserDeprecated" }, "customStatus": { "$ref": "#/definitions/ListCustomStatusDeprecated" }, "customInfluencerStatus": { "$ref": "#/definitions/ListCustomInfluencerStatusDeprecated" }, "listMemberCostAndPerformance": { "$ref": "#/definitions/ListMemberCostAndPerformance" }, "statusId": { "type": "integer" }, "listMemberId": { "type": "integer" }, "participating": { "type": [ "boolean", "null" ] }, "completed": { "type": "boolean" }, "upvotes": { "type": "integer" }, "downvotes": { "type": "integer" }, "totalVotes": { "type": "integer" }, "netVotes": { "type": "integer" }, "optedIn": { "type": "boolean" }, "optedInDate": { "type": "string", "format": "date-time" }, "conversationCount": { "type": "integer" }, "unreadConversationCount": { "type": "integer" }, "hasConversations": { "type": "boolean" }, "postedAt": { "type": "string", "format": "date-time" }, "engagements": { "type": "integer" }, "dueDate": { "type": "string", "format": "date" }, "assessments": { "type": "array", "items": { "type": "object", "properties": { "approves": { "type": "boolean" }, "assessorName": { "type": "string" }, "assessorEmail": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string", "description": "The date and time that the assessment was created." }, "administrator": { "$ref": "#/definitions/AdministratorDeprecated" } } } }, "applicationQuestionResponses": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "applicationProposal": { "type": "object", "properties": { "concept": { "type": "string" }, "quote": { "type": "number", "format": "double" } } }, "draftContent": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "contentType": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "comments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "commenterName": { "type": "string" } } } } } } }, "activations": { "type": "array", "items": { "$ref": "#/definitions/ActivationDeprecated" } }, "instagramPosts": { "type": "array", "items": { "type": "object", "properties": { "link": { "type": "string" }, "imageUrl": { "type": "string" } } } }, "commentsCount": { "type": "integer" }, "hasNotViewed": { "type": "boolean" } } }, "ActionGroupCandidateQueryFilter": { "type": "object", "required": [ "expectedNumberOfInfluencers" ], "properties": { "userFilter": { "$ref": "#/definitions/UserSearch" }, "q": { "type": "string", "description": "Search parameter." }, "statusId": { "type": "array", "items": { "type": "integer" } }, "workflowStageId": { "type": "integer" }, "customStatusId": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "customInfluencerStatusId": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "dueDate": { "type": "array", "items": { "type": [ "string" ] } }, "completed": { "type": "boolean" }, "optedIn": { "type": "integer" }, "participating": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "excludedGlobalUserIds": { "type": "array", "items": { "type": "integer" } }, "expectedNumberOfInfluencers": { "type": "integer" }, "orderProperty": { "type": "string", "enum": [ "statusId", "upvotes", "downvotes", "netVotes", "totalVotes", "dueDate", "optedInDate", "engagements", "createdAt", "customStatusId", "customInfluencerStatusId", "quote", "user.stageJoinDate", "user.id", "user.age", "user.audienceFakeEngagersLevel", "user.audienceFakeFollowersLevel", "user.audienceFraudLevel", "user.audiencePercentageFemale", "user.audiencePercentage_13_17", "user.audiencePercentage_18_24", "user.audiencePercentage_25_34", "user.audiencePercentage_35_44", "user.audiencePercentage_45_54", "user.audiencePercentage_55_64", "user.audiencePercentage_65_plus", "user.audiencePredominantAgeRange", "user.audiencePredominantCity", "user.audiencePredominantCountry", "user.birthday", "user.city", "user.country", "user.deleted", "user.email", "user.fullName", "user.gender", "user.instagramHandle", "user.lastRefreshedAt", "user.loadSource", "user.nudityLevel", "user.profanityLevel", "user.state", "user.violenceLevel", "listMemberCostAndPerformance.listMemberId", "listMemberCostAndPerformance.rewards", "listMemberCostAndPerformance.value", "listMemberCostAndPerformance.cost", "listMemberCostAndPerformance.posts", "listMemberCostAndPerformance.engagements", "listMemberCostAndPerformance.impressions", "listMemberCostAndPerformance.clicks", "listMemberCostAndPerformance.conversions", "listMemberCostAndPerformance.conversionValue", "listMemberCostAndPerformance.cpm", "listMemberCostAndPerformance.cpp", "listMemberCostAndPerformance.cpe", "listMemberCostAndPerformance.committedAmount", "listMemberCostAndPerformance.readyAmount", "listMemberCostAndPerformance.paidAmount", "listMemberCostAndPerformance.emvValue", "listMemberCostAndPerformance.roiValue", "user.instagramAccount.globalUserId", "user.instagramAccount.analysisVersion", "user.instagramAccount.audienceFakeCommentersLevel", "user.instagramAccount.audienceFakeCommentersPercentage", "user.instagramAccount.audienceFakeEngagersLevel", "user.instagramAccount.audienceFakeFollowersLevel", "user.instagramAccount.audienceFakeFollowersPercentage", "user.instagramAccount.audienceFakeLikersLevel", "user.instagramAccount.audienceFakeLikersPercentage", "user.instagramAccount.audienceFraudLevel", "user.instagramAccount.audiencePercentageFemale", "user.instagramAccount.audiencePercentage_13_17", "user.instagramAccount.audiencePercentage_18_24", "user.instagramAccount.audiencePercentage_25_34", "user.instagramAccount.audiencePercentage_35_44", "user.instagramAccount.audiencePercentage_45_54", "user.instagramAccount.audiencePercentage_55_64", "user.instagramAccount.audiencePercentage_65_plus", "user.instagramAccount.audiencePredominantAgeRange", "user.instagramAccount.audiencePredominantCity", "user.instagramAccount.audiencePredominantCountry", "user.instagramAccount.averageComments", "user.instagramAccount.averageEngagements", "user.instagramAccount.averageLikes", "user.instagramAccount.bio", "user.instagramAccount.boughtFollowers", "user.instagramAccount.createdAt", "user.instagramAccount.engagementRate", "user.instagramAccount.followersCount", "user.instagramAccount.followingCount", "user.instagramAccount.fullName", "user.instagramAccount.handle", "user.instagramAccount.instagramExternalId", "user.instagramAccount.instagramProfileId", "user.instagramAccount.isBusiness", "user.instagramAccount.isPrivate", "user.instagramAccount.lastAnalyzedAt", "user.instagramAccount.lastAnalyzedFollowersFraudAt", "user.instagramAccount.loadSource", "user.instagramAccount.mediaCount", "user.instagramAccount.nudityLevel", "user.instagramAccount.previewPostsLastUpdatedAt", "user.instagramAccount.profanityLevel", "user.instagramAccount.profilePicture", "user.instagramAccount.profileType", "user.instagramAccount.sourceDetail", "user.instagramAccount.sponsoredPostRate", "user.instagramAccount.topicsLastAnalyzedAt", "user.instagramAccount.updatedAt", "user.instagramAccount.violenceLevel", "user.instagramAccount.website", "user.facebookProfile.id", "user.facebookProfile.averageComments", "user.facebookProfile.averageEngagements", "user.facebookProfile.averageLikes", "user.facebookProfile.engagementRate", "user.facebookProfile.facebookExternalId", "user.facebookProfile.facebookCreator", "user.facebookProfile.link", "user.facebookProfile.name", "user.facebookProfile.picture", "user.facebookProfile.reach", "user.facebookProfile.type", "user.twitterAccount.id", "user.twitterAccount.userId", "user.twitterAccount.handle", "user.twitterAccount.fullName", "user.twitterAccount.profilePicture", "user.twitterAccount.description", "user.twitterAccount.followersCount", "user.twitterAccount.followingCount", "user.twitterAccount.listedCount", "user.twitterAccount.accountCreatedAt", "user.twitterAccount.location", "user.twitterAccount.geoEnabled", "user.twitterAccount.lang", "user.twitterAccount.timeZone", "user.twitterAccount.utcOffset", "user.twitterAccount.verified", "user.twitterAccount.protected", "user.twitterAccount.averageFavorites", "user.twitterAccount.averageRetweets", "user.twitterAccount.averageEngagements", "user.twitterAccount.engagementRate", "user.twitterAccount.primaryAccount", "user.twitterAccount.twitterExternalId", "user.twitterAccount.createdAt", "user.pinterestAccount.id", "user.pinterestAccount.averageEngagements", "user.pinterestAccount.bio", "user.pinterestAccount.boardsCount", "user.pinterestAccount.createdAt", "user.pinterestAccount.engagementRate", "user.pinterestAccount.externalId", "user.pinterestAccount.firstName", "user.pinterestAccount.followersCount", "user.pinterestAccount.followingCount", "user.pinterestAccount.lastName", "user.pinterestAccount.monthlyViewers", "user.pinterestAccount.pinsCount", "user.pinterestAccount.primaryAccount", "user.pinterestAccount.profilePicture", "user.pinterestAccount.updatedAt", "user.pinterestAccount.userId", "user.pinterestAccount.username", "user.blog.id", "user.blog.globalUserId", "user.blog.language", "user.blog.name", "user.blog.platform", "user.blog.url", "user.youtubeChannel.id", "user.youtubeChannel.userId", "user.youtubeChannel.username", "user.youtubeChannel.bio", "user.youtubeChannel.accountCreatedAt", "user.youtubeChannel.profilePicture", "user.youtubeChannel.followersCount", "user.youtubeChannel.videoCount", "user.youtubeChannel.commentCount", "user.youtubeChannel.viewCount", "user.youtubeChannel.primaryAccount", "user.youtubeChannel.youtubeExternalId", "user.youtubeChannel.handle", "user.youtubeChannel.global_user_id", "draftContent.id", "draftContent.text", "draftContent.listMemberId", "draftContent.createdAt", "draftContent.updatedAt", "draftContent.status", "draftContent.contentType", "draftContent.notes", "draftContent.contentUrl", "draftContent.isArchived", "draftContent.archivedByAccountId", "draftContent.archivedByGlobalUserId", "draftContent.archivedAt", "draftContent.threadId", "draftContent.feedback", "draftContent.uploaderType", "draftContent.uploaderAccountId", "draftContent.uploaderGlobalUserId", "user.tiktokCreator.followersCount", "user.tiktokCreator.engagementRate" ] } } }, "ConversationTemplateDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "category": { "type": "string" }, "title": { "type": "string" }, "subject": { "type": "string" }, "html": { "type": "string" }, "createdBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "lastModifiedBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deliveryMethod": { "type": "string" }, "sendOnEvent": { "type": "string" }, "sendOnDays": { "type": "integer" }, "sendOnTimeframe": { "type": "string" }, "sendOnStatusId": { "type": [ "integer", "null" ] }, "sendOnDate": { "type": "string" }, "slug": { "type": "string" }, "isArchived": { "type": "boolean" } } }, "WorkflowStatusRequirementDeprecated": { "type": "object", "properties": { "satisfied": { "type": "boolean" }, "incentiveId": { "type": "number" }, "name": { "type": "string" } } }, "ActionDeprecated": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier representing a single action." }, "type": { "type": "string", "description": "A key to specify the type of action." }, "title": { "type": "string", "description": "A concise call to action, grabbing the influencer's attention." }, "label": { "type": "string", "description": "Internal label for action." }, "description": { "type": "string", "description": "An elaboration on the title." }, "image": { "type": "string", "description": "An image to associate with the action." }, "instructions": { "type": "string", "description": "Instructions on how to complete the action" }, "linkReference": { "type": "string", "description": "Reference to Link" }, "actionGroupId": { "type": "integer", "x-access": [ "administrator", "root", "influencer" ], "description": "ID of the parent action group." }, "actionGroupType": { "type": "string", "x-access": [ "administrator", "root" ], "description": "Type of the parent action group." }, "actionGroupTitle": { "type": "string" }, "brandSuitabilityGuidelines": { "type": [ "null", "string" ], "description": "Optional guidelines from the parent action group to customize the brand suitability review for this action's campaign." }, "ActionGroup": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single action group." }, "communityId": { "type": "string" }, "communityName": { "type": "string" }, "communityImage": { "type": "string" }, "type": { "type": "string" }, "mainType": { "type": "string", "description": "First action in the group type" }, "name": { "type": "string", "description": "Human-readable description of the action group displayed for administrators.", "x-access": [ "root", "administrator" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "contentType": { "type": "string", "description": "For content action groups, this provides the type of content, which either matches og:image or is derived from internal heuristics." }, "url": { "type": "string", "description": "For content action groups, this contains the url input upon creation." }, "status": { "type": "string", "description": "The state of the action group. One of the set {\"LIVE\", \"PAUSED\", \"PENDING\", \"EXPIRED\"}.", "x-access": [ "root", "administrator" ] }, "startDate": { "format": "date-time", "type": "string", "description": "The scheduled time in which the action group will become available to influencers." }, "endDate": { "format": "date-time", "type": [ "null", "string" ], "description": "The scheduled time in which the action group will no longer be available to influencers." }, "createdAt": { "format": "date-time", "type": [ "null", "string" ] }, "notInCommunity": { "type": "boolean", "x-access": [ "root", "administrator" ], "description": "Filter this action group if the client specifies channel=community." }, "isAutoCreated": { "type": "boolean" }, "isPrimaryReferralActivity": { "type": "boolean" }, "multipleActivations": { "type": "boolean", "description": "Indicates whether this action group can be completed multiple times. Only available for photoChallenge." }, "campaign": { "type": "object", "x-access": [ "root", "administrator" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single campaign." }, "name": { "type": "string", "description": "Name of campaign." }, "description": { "type": "string", "description": "Name of campaign." }, "brand": { "$ref": "#/definitions/BrandDeprecated" }, "hasActivations": { "type": "boolean", "description": "Flag that indicates whether this campaign is associated with any activations." }, "createdAt": { "format": "date-time", "type": "string", "description": "The date and time that the campaign was created." } } }, "audience": { "$ref": "#/definitions/AudienceDeprecated" }, "incentive": { "$ref": "#/definitions/IncentiveDeprecated" }, "incentives": { "items": { "$ref": "#/definitions/IncentiveDeprecated" }, "type": "array" }, "points": { "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" } } }, "hasScheduledNotifications": { "type": "boolean", "description": "Indicates whether the action group is tied to any scheduled notifications. The audience cannot be modified if this is the case." }, "listId": { "type": "integer" }, "listDeliverables": { "type": "array", "items": { "$ref": "#/definitions/ListDeliverable" } }, "influencerReviewDeliverable": { "type": "object", "properties": { "id": { "type": "integer" }, "count": { "type": "integer" }, "listId": { "type": "integer" } } }, "workflowStatuses": { "type": "array", "items": { "$ref": "#/definitions/ListCustomStatusDeprecated" } }, "locale": { "type": "string", "description": "Formatted according to language codes (https://www.w3schools.com/tags/ref_language_codes.asp)" }, "activatedUsersMetrics": { "type": "integer" }, "clicksMetrics": { "type": "integer" }, "engagementsMetrics": { "type": "integer" }, "impressionsMetrics": { "type": "integer" }, "conversionsCountMetrics": { "type": "integer" }, "conversionsValueMetrics": { "type": "number" }, "posts": { "type": "integer" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "cpe": { "type": "number" }, "cpp": { "type": "number" }, "cpm": { "type": "number" }, "cpa": { "type": "number" }, "committedAmount": { "type": "number" }, "paidAmount": { "type": "number" }, "readyAmount": { "type": "number" }, "cost": { "type": "number" }, "roiValue": { "type": "number" }, "workflowSummary": { "type": "object", "properties": { "accepted": { "type": "integer" }, "rejected": { "type": "integer" }, "candidates": { "type": "integer" }, "applicants": { "type": "integer" }, "participants": { "type": "integer" }, "completed": { "type": "integer" } } }, "requiredHashtag": { "type": "string", "description": "Hashtag for action group (required)" }, "ftcHashtag": { "type": "string", "description": "FTC hashtag for an action group." }, "youtubeHashtag": { "type": "string", "description": "YouTube hashtag for an action group." }, "internalDescription": { "type": "string", "description": "Internal description on an action group." }, "activityBudget": { "type": [ "null", "number" ], "description": "Total budget for all actions under an action group." }, "numberOfInfluencers": { "type": [ "null", "integer" ], "description": "Target number of influencers for all actions under an action group." }, "cpeGoal": { "type": [ "number", "null" ], "description": "Cost per engagement goal for a single action group" }, "cpmGoal": { "type": [ "number", "null" ], "description": "Cost per 1000 impressions goal for a single action group" }, "impressionsGoal": { "type": [ "number", "null" ], "description": "Impressions goal for a single action group" }, "engagementsGoal": { "type": [ "number", "null" ], "description": "Engagements goal for a single action group" }, "engagementRateGoal": { "type": [ "number", "null" ], "description": "Engagement rate goal for a single action group" }, "contentDueDate": { "type": [ "string", "null" ], "description": "Due date for content on an action group." }, "draftDueDate": { "type": [ "string", "null" ], "description": "Due date for drafts on an action group." }, "conceptDueDate": { "type": [ "string", "null" ], "description": "Due date for concepts on an action group." }, "primaryNetwork": { "type": "string" }, "hasPointsEnabled": { "type": "boolean" }, "shareableReportLink": { "type": "string" }, "termsOfServiceLink": { "type": "string" }, "autoAcceptApplicant": { "type": "boolean" }, "globalUserListDefinitionId": { "type": [ "integer", "null" ] }, "ready": { "type": "number" }, "pending": { "type": "number" }, "fulfilled": { "type": "number" }, "brief": { "type": "string" }, "hideOnIcm": { "type": "boolean" }, "application": { "type": "object", "properties": { "requestBrandedContentPermission": { "type": "boolean" } } }, "community": { "type": "object", "properties": { "instagramHandle": { "type": "string" } } }, "isSetupEnabled": { "type": "boolean" }, "isCopied": { "type": "boolean" }, "hideTemplateUpdateCTA": { "type": "boolean" }, "isLaterCreatorExperienceEnabled": { "type": "boolean" }, "isMavelyCreatorExperienceEnabled": { "type": "boolean" }, "budgetReferenceId": { "type": [ "string", "null" ] }, "budgetReferenceIdType": { "type": [ "string", "null" ], "enum": [ "IROF", "OPPORTUNITY", null ] }, "brandSuitabilityGuidelines": { "type": [ "string", "null" ] }, "publicSummary": { "type": [ "string", "null" ] }, "version": { "type": "integer", "description": "Version of the action group." }, "lastPolledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time the action group was manually polled for updates." } } }, "routing": { "$ref": "#/definitions/RoutingDeprecated" }, "survey": { "type": "object", "required": [ "questions" ], "properties": { "id": { "type": "integer", "description": "id of form" }, "reviewProductId": { "type": "integer" }, "product": { "$ref": "#/definitions/ProductDeprecated" }, "questions": { "type": "array", "description": "Array of form questions", "items": { "$ref": "#/definitions/QuestionDeprecated" } }, "title": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "incentivized": { "x-access": [ "administrator", "root" ], "type": "boolean", "description": "whether the form is incentivized" }, "responses": { "type": "array", "x-access": [ "administrator", "root" ], "items": { "type": "object", "properties": { "membership": { "$ref": "#/definitions/MembershipDeprecated" }, "questionResponses": { "type": "array", "items": { "type": "object" } } } } } } }, "url": { "type": "string", "description": "Url to be visited by influencers." }, "link": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "title": { "type": "string" }, "communityId": { "type": "string" }, "url": { "type": "string" }, "shortLink": { "type": "string" }, "trackingPixelCode": { "type": "string" }, "conversionId": { "type": "string", "description": "Assign a conversion to track conversions resulting from clicks on this link." }, "domainId": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" }, "numClicks": { "type": "integer" }, "lastUpdated": { "type": "string" }, "isDeleted": { "type": "string" }, "membershipId": { "type": "string" }, "conversions": { "type": "integer" }, "conversionsValue": { "type": "number" }, "providerCode": { "type": "string" }, "providerName": { "type": "string" }, "isAffiliate": { "type": "boolean" }, "destinationUrl": { "type": "string", "description": "A user will ultimately be redirected to this url when someone clicks on the link contained in an artifact on a network." }, "metaInformation": { "$ref": "#/definitions/MetaInformationDeprecated" } } }, "previewContentType": { "type": "string", "description": "For content activities, this indicates the type of content to be previewed." }, "article": { "type": "object", "properties": { "html": { "type": "string", "description": "Article content to be viewed by influencers." } } }, "video": { "type": "object", "properties": { "url": { "type": "string", "description": "Video to be watched by influencers." } } }, "submit": { "type": "string", "description": "Type of content for influencers to submit" }, "reviewFormId": { "type": "integer", "description": "Review Form Id tied to this action" }, "productId": { "type": "integer", "description": "Product Id tied to this action" }, "product": { "$ref": "#/definitions/ProductDeprecated" }, "activations": { "description": "If the user has created any activations for this action, then they are displayed here.", "x-access": [ "influencer" ], "type": "array", "items": { "$ref": "#/definitions/ActivationURI" } }, "pendingActivation": { "$ref": "#/definitions/PendingActivationURI" }, "conversion": { "$ref": "#/definitions/ConversionTagDeprecated" }, "conversionAssignedAt": { "format": "date-time", "type": "string", "description": "The date time when a conversion tag is assigned to this action.", "x-access": [ "administrator", "root" ] }, "brand": { "$ref": "#/definitions/BrandDeprecated" }, "points": { "type": "number", "description": "The number of points an activity is worth." }, "needsModeration": { "type": "boolean", "description": "Indicates whether content created for this Action needs to be approved by a Brand Manager." }, "multipleActivations": { "type": "boolean", "description": "Indicates whether this action can be completed multiple times. Only available for photoChallenge." }, "required": { "type": "boolean", "description": "Indicates whether this action is required to be completed." }, "membershipId": { "type": "number" } } }, "ActionGroupDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single action group." }, "communityId": { "type": "string" }, "communityName": { "type": "string" }, "communityImage": { "type": "string" }, "type": { "type": "string" }, "mainType": { "type": "string", "description": "First action in the group type" }, "name": { "type": "string", "description": "Human-readable description of the action group displayed for administrators.", "x-access": [ "root", "administrator" ] }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "contentType": { "type": "string", "description": "For content action groups, this provides the type of content, which either matches og:image or is derived from internal heuristics." }, "url": { "type": "string", "description": "For content action groups, this contains the url input upon creation." }, "status": { "type": "string", "description": "The state of the action group. One of the set {\"LIVE\", \"PAUSED\", \"PENDING\", \"EXPIRED\"}.", "x-access": [ "root", "administrator" ] }, "startDate": { "format": "date-time", "type": "string", "description": "The scheduled time in which the action group will become available to influencers." }, "endDate": { "format": "date-time", "type": [ "null", "string" ], "description": "The scheduled time in which the action group will no longer be available to influencers." }, "createdAt": { "format": "date-time", "type": [ "null", "string" ] }, "notInCommunity": { "type": "boolean", "x-access": [ "root", "administrator" ], "description": "Filter this action group if the client specifies channel=community." }, "isAutoCreated": { "type": "boolean" }, "isPrimaryReferralActivity": { "type": "boolean" }, "multipleActivations": { "type": "boolean", "description": "Indicates whether this action group can be completed multiple times. Only available for photoChallenge." }, "campaign": { "type": "object", "x-access": [ "root", "administrator" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single campaign." }, "name": { "type": "string", "description": "Name of campaign." }, "description": { "type": "string", "description": "Name of campaign." }, "brand": { "$ref": "#/definitions/BrandDeprecated" }, "hasActivations": { "type": "boolean", "description": "Flag that indicates whether this campaign is associated with any activations." }, "createdAt": { "format": "date-time", "type": "string", "description": "The date and time that the campaign was created." } } }, "audience": { "$ref": "#/definitions/AudienceDeprecated" }, "incentive": { "$ref": "#/definitions/IncentiveDeprecated" }, "incentives": { "items": { "$ref": "#/definitions/IncentiveDeprecated" }, "type": "array" }, "actions": { "items": { "$ref": "#/definitions/ActionDeprecated" }, "type": "array" }, "points": { "type": "object", "properties": { "min": { "type": "integer" }, "max": { "type": "integer" } } }, "hasScheduledNotifications": { "type": "boolean", "description": "Indicates whether the action group is tied to any scheduled notifications. The audience cannot be modified if this is the case." }, "listId": { "type": "integer" }, "listDeliverables": { "type": "array", "items": { "$ref": "#/definitions/ListDeliverable" } }, "influencerReviewDeliverable": { "type": "object", "properties": { "id": { "type": "integer" }, "count": { "type": "integer" }, "listId": { "type": "integer" } } }, "workflowStatuses": { "type": "array", "items": { "$ref": "#/definitions/ListCustomStatusDeprecated" } }, "locale": { "type": "string", "description": "Formatted according to language codes (https://www.w3schools.com/tags/ref_language_codes.asp)" }, "activatedUsersMetrics": { "type": "integer" }, "clicksMetrics": { "type": "integer" }, "engagementsMetrics": { "type": "integer" }, "impressionsMetrics": { "type": "integer" }, "conversionsCountMetrics": { "type": "integer" }, "conversionsValueMetrics": { "type": "number" }, "posts": { "type": "integer" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "cpe": { "type": "number" }, "cpp": { "type": "number" }, "cpm": { "type": "number" }, "cpa": { "type": "number" }, "committedAmount": { "type": "number" }, "paidAmount": { "type": "number" }, "readyAmount": { "type": "number" }, "cost": { "type": "number" }, "roiValue": { "type": "number" }, "workflowSummary": { "type": "object", "properties": { "accepted": { "type": "integer" }, "rejected": { "type": "integer" }, "candidates": { "type": "integer" }, "applicants": { "type": "integer" }, "participants": { "type": "integer" }, "completed": { "type": "integer" } } }, "requiredHashtag": { "type": "string", "description": "Hashtag for action group (required)" }, "ftcHashtag": { "type": "string", "description": "FTC hashtag for an action group." }, "youtubeHashtag": { "type": "string", "description": "YouTube hashtag for an action group." }, "internalDescription": { "type": "string", "description": "Internal description on an action group." }, "activityBudget": { "type": [ "null", "number" ], "description": "Total budget for all actions under an action group." }, "numberOfInfluencers": { "type": [ "null", "integer" ], "description": "Target number of influencers for all actions under an action group." }, "cpeGoal": { "type": [ "number", "null" ], "description": "Cost per engagement goal for a single action group" }, "cpmGoal": { "type": [ "number", "null" ], "description": "Cost per 1000 impressions goal for a single action group" }, "impressionsGoal": { "type": [ "number", "null" ], "description": "Impressions goal for a single action group" }, "engagementsGoal": { "type": [ "number", "null" ], "description": "Engagements goal for a single action group" }, "engagementRateGoal": { "type": [ "number", "null" ], "description": "Engagement rate goal for a single action group" }, "contentDueDate": { "type": [ "string", "null" ], "description": "Due date for content on an action group." }, "draftDueDate": { "type": [ "string", "null" ], "description": "Due date for drafts on an action group." }, "conceptDueDate": { "type": [ "string", "null" ], "description": "Due date for concepts on an action group." }, "primaryNetwork": { "type": "string" }, "hasPointsEnabled": { "type": "boolean" }, "shareableReportLink": { "type": "string" }, "termsOfServiceLink": { "type": "string" }, "autoAcceptApplicant": { "type": "boolean" }, "globalUserListDefinitionId": { "type": [ "integer", "null" ] }, "ready": { "type": "number" }, "pending": { "type": "number" }, "fulfilled": { "type": "number" }, "brief": { "type": "string" }, "hideOnIcm": { "type": "boolean" }, "application": { "type": "object", "properties": { "requestBrandedContentPermission": { "type": "boolean" } } }, "community": { "type": "object", "properties": { "instagramHandle": { "type": "string" } } }, "isSetupEnabled": { "type": "boolean" }, "isCopied": { "type": "boolean" }, "hideTemplateUpdateCTA": { "type": "boolean" }, "isLaterCreatorExperienceEnabled": { "type": "boolean" }, "isMavelyCreatorExperienceEnabled": { "type": "boolean" }, "budgetReferenceId": { "type": [ "string", "null" ] }, "budgetReferenceIdType": { "type": [ "string", "null" ], "enum": [ "IROF", "OPPORTUNITY", null ] }, "brandSuitabilityGuidelines": { "type": [ "string", "null" ] }, "publicSummary": { "type": [ "string", "null" ] }, "version": { "type": "integer", "description": "Version of the action group." }, "lastPolledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The last time the action group was manually polled for updates." } } }, "ArtifactDeprecated": { "type": "object", "properties": { "key": { "type": "string", "description": "A key representing a type of entity created on a network, such as a post, follow, like, or comment. This is network-agnostic, e.g. a tweet or instgram post are both a \"post\"." }, "before": { "type": "string", "description": "Step for influencer to complete before posting on a network." }, "metaInformation": { "$ref": "#/definitions/MetaInformationDeprecated" }, "placeholder": { "type": "string", "description": "Text to include as a default to an influencer when they create an artifact." }, "hashtag": { "type": "string", "description": "A hashtag that the user is required to include in the artifact in order to create an activation." }, "resourceId": { "type": "string", "description": "The id of the artifact to interact with." }, "resourceUrl": { "type": "string", "description": "The url of the artifact to interact with, if needed." }, "linkReference": { "x-access": [ "influencer" ], "type": "string", "description": "The reference to a link." }, "link": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "title": { "type": "string" }, "communityId": { "type": "string" }, "url": { "type": "string" }, "shortLink": { "type": "string" }, "trackingPixelCode": { "type": "string" }, "conversionId": { "type": "string", "description": "Assign a conversion to track conversions resulting from clicks on this link." }, "domainId": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" }, "numClicks": { "type": "integer" }, "lastUpdated": { "type": "string" }, "isDeleted": { "type": "string" }, "membershipId": { "type": "string" }, "conversions": { "type": "integer" }, "conversionsValue": { "type": "number" }, "providerCode": { "type": "string" }, "providerName": { "type": "string" }, "isAffiliate": { "type": "boolean" }, "destinationUrl": { "type": "string", "description": "A user will ultimately be redirected to this url when someone clicks on the link contained in an artifact on a network." }, "metaInformation": { "$ref": "#/definitions/MetaInformationDeprecated" } } }, "example": { "type": "string", "description": "Example text for this artifact." } } }, "ActivationDeprecated": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier representing a single activation." }, "externalId": { "type": "string", "description": "Instagram external id" }, "profilePicture": { "type": "string", "description": "Link to the user's Facebook profile picture using the External Facebook id of the user who created this activation." }, "membershipId": { "type": "integer", "description": "Community membership id of user who created this activation used that can be used for pulling up influencer profiles." }, "globalUserId": { "type": "integer" }, "createdByAccountId": { "type": "string", "description": "Id of self-service application user who manually bound or manually entered this activation" }, "updatedByAccountId": { "type": "string", "description": "Id of self-service application user who manually updated this activation" }, "createdAt": { "type": "string", "format": "date-time", "description": "CREATED AT TIME" }, "approvalStatus": { "type": "string", "description": "The Approval status of the activation." }, "points": { "type": "number", "description": "Number of points that the activation grants." }, "isApproved": { "type": "boolean", "x-access": [ "root", "administrator" ], "description": "Indicates whether this activation has been approved to be publicly available." }, "selfReported": { "type": "boolean" }, "user": { "type": "object", "properties": { "id": { "type": [ "integer", "string" ] }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePicture": { "type": "string" }, "unverified": { "type": "string", "enum": [ "hidden", "emails", "excludes" ] }, "country": { "type": "string", "enum": [ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Caribbean Netherlands", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Collectivity of Saint Martin", "Colombia", "Comoros", "Cook Islands", "Costa Rica", "Côte d'Ivoire", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Federated States of Micronesia", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Jamaica", "Japan", "Italy", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia (FYROM)", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of the Congo", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Saint-Barthélemy", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States Minor Outlying Islands", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ] }, "state": { "type": "string" }, "city": { "type": "string" }, "zip": { "type": "string" }, "street": { "type": "string" }, "apt": { "type": "string" }, "phone": { "type": "string" }, "age": { "type": "integer" }, "gender": { "type": "string", "enum": [ "male", "female", "other", "non_bin", "describe" ] }, "email": { "type": "string" }, "talentManagerEmail": { "type": "string" }, "registered": { "type": "boolean" }, "birthday": { "type": "string", "format": "date" }, "facebookProfile": { "$ref": "#/definitions/FacebookProfileDeprecated" }, "instagramAccount": { "$ref": "#/definitions/InstagramAccountDeprecated" }, "instagramProfile": { "$ref": "#/definitions/InstagramProfileDeprecated" }, "tiktokCreator": { "$ref": "#/definitions/TikTokCreatorDeprecated" }, "twitterAccount": { "$ref": "#/definitions/TwitterAccountDeprecated" }, "pinterestAccount": { "$ref": "#/definitions/PinterestAccountDeprecated" }, "youtubeChannel": { "$ref": "#/definitions/YoutubeChannelDeprecated" }, "blog": { "$ref": "#/definitions/Blog" }, "lists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } } }, "appMembership": { "$ref": "#/definitions/MembershipDeprecated" }, "userContactInfo": { "type": "object", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "emailIsVerified": { "type": "boolean" }, "referralSlug": { "type": "string" }, "referralCount": { "type": "string" }, "gender": { "type": "string" }, "genderDescription": { "type": "string" } } }, "influencerTopics": { "type": "array", "items": { "$ref": "#/definitions/TopicDeprecated" } }, "activations": { "type": "integer" }, "engagements": { "type": "integer" }, "clicksCount": { "type": "integer" }, "conversionCount": { "type": "integer" }, "conversionValue": { "type": "number", "format": "double" }, "rewards": { "type": "integer" }, "facebookPostsCount": { "type": "integer" }, "instagramPostsCount": { "type": "integer" }, "twitterPostsCount": { "type": "integer" }, "pinterestPostsCount": { "type": "integer" }, "membershipDataPoints": { "type": "array", "items": { "type": "object", "properties": { "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinitionDeprecated" }, "lastEditedBy": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "value": { "type": "array", "items": { "type": "string" } } } } }, "membershipCostAndPerformance": { "$ref": "#/definitions/MembershipCostAndPerformanceDeprecated" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePercentageFemale": { "type": "number" }, "audiencePercentage_13_17": { "type": "number" }, "audiencePercentage_18_24": { "type": "number" }, "audiencePercentage_25_34": { "type": "number" }, "audiencePercentage_35_44": { "type": "number" }, "audiencePercentage_45_54": { "type": "number" }, "audiencePercentage_55_64": { "type": "number" }, "audiencePercentage_65_plus": { "type": "number" }, "cpe": { "type": "number" }, "cpm": { "type": "number" }, "cpp": { "type": "number" }, "audienceFraudLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "audienceFakeFollowersLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "audienceFakeEngagersLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "nudityLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "violenceLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "profanityLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "hasPublicSummaryRecord": { "type": "boolean" } } }, "action": { "$ref": "#/definitions/ActionDeprecated" }, "content": { "$ref": "#/definitions/ActivationContentDeprecated" }, "instagramAccount": { "$ref": "#/definitions/InstagramAccountDeprecated" }, "facebookProfile": { "$ref": "#/definitions/FacebookProfileDeprecated" }, "twitterAccount": { "$ref": "#/definitions/TwitterAccountDeprecated" }, "pinterestAccount": { "$ref": "#/definitions/PinterestAccountDeprecated" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "membership": { "$ref": "#/definitions/MembershipDeprecated" }, "campaign": { "$ref": "#/definitions/CampaignDeprecated" }, "surveyResponses": { "type": "array", "items": { "$ref": "#/definitions/UserQuestionResponse" } }, "reviewContent": { "$ref": "#/definitions/ReviewFormResponseDeprecated" }, "validation": { "type": "object", "properties": { "ftcStatus": { "type": "string", "enum": [ "unknown", "valid", "invalid" ] } } }, "brandedContentTagIGHandle": { "type": "string", "description": "A business partner that an influencer tagged in their Partnership Ads posts." }, "tikTokHandle": { "type": "string", "description": "TikTok username handle" }, "tikTokMetrics": { "type": "object" }, "tags": { "type": "array", "items": { "type": "string" } }, "exportFilenames": { "type": "array", "items": { "type": "string" } } } }, "ActivationContentDeprecated": { "type": "object", "properties": { "stars": { "type": "integer", "description": "Number of stars for the activation" }, "image": { "type": "string" }, "video": { "type": "string" }, "postLink": { "type": "string" }, "text": { "type": "string" }, "privacy": { "type": "string" }, "likes": { "type": "integer" }, "likesOrganic": { "type": "integer", "description": "Organic-only likes (excludes paid/promoted), from YouTube BrandConnect insights" }, "likesPaid": { "type": "integer", "description": "Paid/promoted likes, from YouTube BrandConnect insights" }, "comments": { "type": "integer" }, "commentsOrganic": { "type": "integer", "description": "Organic-only comments (excludes paid/promoted), from YouTube BrandConnect insights" }, "commentsPaid": { "type": "integer", "description": "Paid/promoted comments, from YouTube BrandConnect insights" }, "shares": { "type": "integer" }, "sharesOrganic": { "type": "integer", "description": "Organic-only shares (excludes paid/promoted), from YouTube BrandConnect insights" }, "sharesPaid": { "type": "integer", "description": "Paid/promoted shares, from YouTube BrandConnect insights" }, "engagements": { "type": "integer" }, "benchmarkAverageEngagements": { "type": "integer" }, "avgWatchTime": { "type": "integer" }, "follows": { "type": "integer" }, "navigation": { "type": "integer" }, "navigationSwipeForward": { "type": "integer" }, "navigationTapBack": { "type": "integer" }, "navigationTapExit": { "type": "integer" }, "navigationTapForward": { "type": "integer" }, "profileActivity": { "type": "integer" }, "profileActivityBioLinkClicked": { "type": "integer" }, "profileActivityCall": { "type": "integer" }, "profileActivityDirection": { "type": "integer" }, "profileActivityEmail": { "type": "integer" }, "profileActivityOther": { "type": "integer" }, "profileActivityText": { "type": "integer" }, "profileVisits": { "type": "integer" }, "replies": { "type": "integer" }, "saved": { "type": "integer" }, "totalInteractions": { "type": "integer" }, "videoViewTotalTime": { "type": "integer" }, "views": { "type": "integer" }, "viewsOrganic": { "type": "integer", "description": "Organic-only views (excludes paid/promoted), from YouTube BrandConnect insights" }, "viewsPaid": { "type": "integer", "description": "Paid/promoted views, from YouTube BrandConnect insights" }, "reach": { "type": "integer" }, "engagementRate": { "type": "number" }, "benchmarkEngagementRate": { "type": "number" }, "clicks": { "type": "integer" }, "estimatedImpressions": { "type": "integer" }, "impressionsSource": { "type": "string" }, "conversions": { "type": "integer" }, "conversionValue": { "type": "number" }, "isDeleted": { "type": "boolean" }, "network": { "type": "string" }, "ytbcLinkState": { "type": "string", "enum": [ "PENDING", "ACTIVE", "DECLINED" ], "description": "BrandConnect VideoCollaboration link state for a YouTube video (PENDING/ACTIVE/DECLINED). Absent for non-YouTube content or videos not yet linked." }, "postDate": { "type": "string", "format": "date" }, "status": { "type": "string" }, "carouselPosts": { "type": "array", "items": { "type": "object", "required": [ "id", "savedUrl", "type" ], "properties": { "id": { "type": "string" }, "savedUrl": { "type": "string" }, "type": { "type": "string" } } } } } }, "ActivityHistory": { "type": "object", "properties": { "eventType": { "type": "string" }, "eventId": { "type": "string" }, "activationId": { "type": "integer" }, "title": { "type": "string" }, "description": { "type": "string" }, "eventAt": { "type": "string" }, "actorType": { "type": "string" }, "tiktokCampaignCode": { "type": "string" }, "inviteLink": { "type": "string" }, "actorName": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "markedAsUnread": { "type": "boolean" }, "isArchived": { "type": "boolean" }, "count": { "type": "integer" }, "influencerInitiated": { "type": "boolean" }, "scheduledFor": { "type": "string", "format": "date-time" }, "scheduledMessageId": { "type": "integer" }, "hasScheduledReply": { "type": "boolean" }, "rate": { "type": "string" }, "concept": { "type": "string" } } }, "Application": { "type": "object", "required": [ "survey" ], "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "status": { "type": "string" }, "requireFacebook": { "type": "boolean", "description": "Whether an influencer must connect their Facebook account to participate in activity." }, "requireInstagram": { "type": "boolean", "description": "Whether an influencer must connect their Instagram account to participate in activity." }, "requireMavely": { "type": "boolean", "description": "Whether an influencer must connect their Mavely account to participate in activity." }, "requirePinterest": { "type": "boolean", "description": "Whether an influencer must connect their Pinterest account to participate in activity." }, "requireTwitter": { "type": "boolean", "description": "Whether an influencer must connect their Twitter account to participate in activity." }, "requireTiktok": { "type": "boolean", "description": "Whether an influencer must connect their Tiktok account to participate in activity." }, "requireYoutube": { "type": "boolean", "description": "Whether an influencer must connect their YouTube channel to participate in activity. When null, sapi auto-derives from the campaign template — true iff any list_requirements row has a YouTube content type." }, "requireQuote": { "type": "boolean", "description": "Whether an influencer must provide a rate to participate in activity." }, "requireConcept": { "type": "boolean", "description": "Whether an influencer must provide a concept to participate in activity." }, "requirePhoneNumber": { "type": "boolean", "description": "Whether an influencer must provide their phone number when applying for a campaign." }, "requireStreetAddress": { "type": "boolean", "description": "Whether an influencer must provide their street address when applying for a campaign." }, "requirePrivacyPolicy": { "type": "boolean", "description": "Whether an influencer must agree to the privacy policy before applying to a campaign." }, "shareWithLater": { "type": "boolean" }, "survey": { "description": "Datapoint survey for an influencer to complete.", "$ref": "#/definitions/ReviewFormDeprecated" }, "url": { "type": "string", "description": "Link to campaign application" }, "locale": { "type": "string" }, "requestBrandedContentPermission": { "type": "boolean", "description": "Whether a marketer wants to request permission to use influencer generated Instagram content in Partnership Ads." }, "requireEthnicityQuestion": { "type": "boolean", "description": "Whether an influencer must provide ethnicity information" }, "cashPaymentAppId": { "type": "number" }, "fulfillmentStage": { "type": "string" } } }, "BatchJob": { "type": "object", "properties": { "status": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "beganProcessingAt": { "type": "string" }, "completedAt": { "type": "string" }, "failedAt": { "type": "string" }, "requester": { "type": "string" }, "messagesProcessed": { "type": "integer" }, "params": { "type": "string" }, "total": { "type": "integer" }, "type": { "type": "string" } } }, "BazaarVoiceAppProductDeprecated": { "type": "object", "properties": { "reviewProductId": { "type": "integer", "description": "Product id assigned by Mavrck" }, "externalBazaarProductId": { "type": "string", "description": "Product id assigned by BazaarVoice" } } }, "BlogContent": { "type": "object", "properties": { "link": { "type": "string" }, "title": { "type": "string" }, "image": { "type": "string" }, "status": { "type": "string" }, "postDate": { "type": "string", "format": "date" }, "canonicalUrlId": { "type": "integer" } } }, "BlogDeprecated": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "platform": { "type": "string" }, "language": { "type": "string" } } }, "CampaignDeprecated": { "type": "object", "x-access": [ "root", "administrator" ], "properties": { "id": { "type": "integer", "description": "Unique identifier representing a single campaign." }, "name": { "type": "string", "description": "Name of campaign." }, "description": { "type": "string", "description": "Name of campaign." }, "brand": { "$ref": "#/definitions/BrandDeprecated" }, "actionGroups": { "type": "array", "description": "The action groups for this campaign.", "items": { "$ref": "#/definitions/ActionGroupDeprecated" } }, "hasActivations": { "type": "boolean", "description": "Flag that indicates whether this campaign is associated with any activations." }, "createdAt": { "format": "date-time", "type": "string", "description": "The date and time that the campaign was created." } } }, "Attachment": { "type": "object", "properties": { "originalName": { "type": "string" }, "encoding": { "type": "string" }, "buffer": { "type": "string" }, "mimeType": { "type": "string" }, "disposition": { "type": "string" }, "size": { "type": "integer" }, "uri": { "type": "string" }, "contentId": { "type": "string" } } }, "Conversation": { "type": "object", "properties": { "id": { "type": "integer" }, "communityId": { "type": "string" }, "subject": { "type": "string" }, "mostRecentMessageCreatedAt": { "type": "string", "format": "date-time" }, "mostRecentMessageParsedReply": { "type": "string" }, "mostRecentMessageSenderDisplayName": { "type": "string" }, "hasAttachment": { "type": "boolean" }, "hasInbound": { "type": "boolean" }, "hasOutbound": { "type": "boolean" }, "markedAsUnread": { "type": "boolean" }, "messageCount": { "type": "integer" }, "draftCount": { "type": "integer" }, "contextType": { "type": "string" }, "contextTitle": { "type": "string" }, "contextLink": { "type": "string" }, "isArchived": { "type": "boolean" }, "listMembers": { "type": "array", "items": { "$ref": "#/definitions/ListMemberDeprecated" } }, "participants": { "type": "array", "items": { "$ref": "#/definitions/MessageRecipient" } }, "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } } } }, "CampaignFolder": { "type": "object", "properties": { "title": { "type": "string" }, "id": { "type": "string" }, "unread": { "type": "integer" } } }, "GeneralFolders": { "type": "object", "properties": { "inbox": { "type": "integer" }, "generalInquiries": { "type": "integer" }, "draft": { "type": "integer" }, "sent": { "type": "integer" }, "archived": { "type": "integer" } } }, "ConversationResponseMetadata": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "markedAsUnreadCount": { "type": "integer" } } }, "Message": { "type": "object", "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "messageIdHeader": { "type": "string" }, "conversationId": { "type": "string" }, "scheduledFor": { "type": "string", "format": "date-time" }, "scheduledMessage": { "type": "object", "properties": { "id": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "messageId": { "type": "integer" }, "accountId": { "type": "integer" }, "communityId": { "type": "string" }, "sendAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "inReplyToHeader": { "type": "string" }, "status": { "type": "string" }, "html": { "type": "string" }, "parsedReply": { "type": "string" }, "isInbound": { "type": "boolean" }, "hasBeenOpened": { "type": "boolean" }, "hasBeenDelivered": { "type": "boolean" }, "hasBeenBounced": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "sentBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "modifiedBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "createdBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/MessageRecipient" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "templates": { "type": "array", "items": { "$ref": "#/definitions/ConversationTemplateDeprecated" } }, "draftReply": { "type": "object", "properties": { "id": { "type": "integer" }, "subject": { "type": "string" }, "messageIdHeader": { "type": "string" }, "conversationId": { "type": "string" }, "scheduledFor": { "type": "string", "format": "date-time" }, "scheduledMessage": { "type": "object", "properties": { "id": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" }, "messageId": { "type": "integer" }, "accountId": { "type": "integer" }, "communityId": { "type": "string" }, "sendAt": { "type": "string", "format": "date-time" }, "status": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "inReplyToHeader": { "type": "string" }, "status": { "type": "string" }, "html": { "type": "string" }, "parsedReply": { "type": "string" }, "isInbound": { "type": "boolean" }, "hasBeenOpened": { "type": "boolean" }, "hasBeenDelivered": { "type": "boolean" }, "hasBeenBounced": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "modifiedAt": { "type": "string", "format": "date-time" }, "sentBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "modifiedBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "createdBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "recipients": { "type": "array", "items": { "$ref": "#/definitions/MessageRecipient" } }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/Attachment" } }, "templates": { "type": "array", "items": { "$ref": "#/definitions/ConversationTemplateDeprecated" } } } } } }, "MessageEvent": { "type": "object", "properties": { "event": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "reason": { "type": "string" }, "status": { "type": "string" }, "ip": { "type": "string" }, "userAgent": { "type": "string" }, "email": { "type": "string" } } }, "MessageRecipient": { "type": "object", "properties": { "displayName": { "type": [ "string", "null" ] }, "email": { "type": "string" }, "emailId": { "type": "integer" }, "role": { "type": "string", "enum": [ "from", "to", "cc" ] } } }, "ListMemberCostAndPerformance": { "type": "object", "properties": { "listMemberId": { "type": "integer" }, "rewards": { "type": "integer" }, "value": { "type": "number" }, "cost": { "type": "number" }, "posts": { "type": "integer" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "clicks": { "type": "integer" }, "conversions": { "type": "integer" }, "conversionValue": { "type": "number" }, "cpm": { "type": "number" }, "cpe": { "type": "number" }, "cpp": { "type": "number" } } }, "MembershipCostAndPerformanceDeprecated": { "type": "object", "properties": { "membershipId": { "type": "integer" }, "rewards": { "type": "integer" }, "value": { "type": "number" }, "cost": { "type": "number" }, "activations": { "type": "integer" }, "posts": { "type": "integer" }, "engagements": { "type": "integer" }, "impressions": { "type": "integer" }, "clicks": { "type": "integer" }, "conversions": { "type": "integer" }, "conversionValue": { "type": "number" }, "cpm": { "type": "number" }, "cpe": { "type": "number" }, "cpp": { "type": "number" }, "cpa": { "type": "number" } } }, "DataPointDefinitionDeprecated": { "type": "object", "required": [ "name", "multi", "customSet", "type" ], "properties": { "id": { "type": "integer", "description": "Unique identifier for the data point." }, "key": { "type": "string", "description": "Key for the datapoint" }, "name": { "type": "string", "description": "Display name for the data point." }, "description": { "type": "string", "description": "The description of the datapoint definition", "x-access": [ "root", "administrator" ] }, "multi": { "type": "boolean", "description": "Boolean indicating whether multiple responses are allowed." }, "customSet": { "type": "boolean", "description": "Boolean indicating whether there is a custom set of responses, otherwise it is free-form." }, "type": { "type": "string", "description": "Type of the data point, e.g. string, integer_range." }, "markUpDescription": { "type": "string", "description": "The markup display description for the data point." }, "communityId": { "type": "integer", "description": "The communityId to which this data point definition belongs.", "x-access": [ "root" ] }, "createdAt": { "type": "string", "format": "date-time", "description": "Date time data point created.", "x-access": [ "root", "administrator" ] }, "updatedAt": { "type": "string", "format": "date-time", "description": "Date time data point updated.", "x-access": [ "root", "administrator" ] }, "mergeTag": { "type": "boolean", "description": "1 if the data point should be included as a merge tag, 0 otherwise" }, "archived": { "type": "boolean", "description": "1 if the data point is archived, 0 if it is not" }, "setElements": { "$ref": "#/definitions/DataPointDefinitionSetElementDeprecated" }, "membersCompleted": { "type": "integer", "description": "The count of members who have completed this data point.", "x-access": [ "administrator" ] }, "actionGroups": { "type": "array", "description": "An array of live action groups that this datapoint is a part of", "x-access": [ "administrator" ], "items": { "type": "object", "properties": { "id": { "type": "integer" }, "title": { "type": "string" } } } } } }, "EmailAccount": { "type": "object", "properties": { "email": { "type": "string" } } }, "FacebookProfileDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "facebookExternalId": { "type": "string" }, "name": { "type": "string" }, "link": { "type": "string" }, "picture": { "type": "string" }, "reach": { "type": "integer" }, "averageLikes": { "type": "integer" }, "averageComments": { "type": "integer" }, "averageEngagements": { "type": "integer" }, "engagementRate": { "type": "number" }, "type": { "type": "string" }, "available": { "type": "boolean" }, "active": { "type": "boolean" }, "expiresAt": { "type": "string", "format": "date-time" }, "facebookUser": { "type": "object", "properties": { "isExpired": { "type": "boolean" } } } } }, "FraudulentGlobalUser": { "type": "object", "properties": { "assessmentDescription": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "GlobalUsersSummary": { "type": "object", "properties": { "data": { "type": "object", "properties": { "summary": { "items": { "type": "object", "properties": { "display": { "type": "string" }, "value": { "type": "number" } } }, "type": "array" }, "totals": { "type": "object", "properties": { "members": { "type": "integer" }, "totalReach": { "type": "number" }, "averageFollowers": { "type": "number" }, "averageEngagementRate": { "type": "number" } } } } } } }, "InfluencerContractCampaignTemplate": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique integer identifying a single campaign-level influencer contract template." }, "campaignId": { "type": "integer", "description": "Unique integer identifying a single action group, referred to as a campaign client-side." }, "template": { "type": "string", "description": "Campaign-level influencer contract template." }, "contract": { "type": "string", "description": "Campaign-level influencer contract." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedBy": { "$ref": "#/definitions/AdministratorAccountsDeprecated" } } }, "InfluencerContractCommunityTemplate": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique integer identifying a single community-level influencer contract template." }, "communityId": { "type": "string", "description": "Unique string identifying a single community." }, "template": { "type": "string", "description": "Community-level influencer contract template." }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedBy": { "$ref": "#/definitions/AdministratorAccountsDeprecated" } } }, "TextSafeSearchDeprecated": { "type": "object", "properties": { "profanityWordCount": { "type": "integer" } } }, "VisualSafeSearchDeprecated": { "type": "object", "properties": { "adult": { "type": "string" }, "racy": { "type": "string" }, "medical": { "type": "string" }, "spoof": { "type": "string" }, "violence": { "type": "string" } } }, "ListCustomInfluencerStatusDeprecated": { "type": "object", "required": [ "label" ], "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "influencerLabel": { "type": "string" }, "influencerInstructions": { "type": "string" } } }, "ListCustomStatusDeprecated": { "type": "object", "required": [ "label" ], "properties": { "id": { "type": "integer" }, "label": { "type": "string" }, "ctaLabel": { "type": "string" }, "auxiliaryLabel": { "type": "string" }, "slug": { "type": "string" }, "phase": { "type": "string" }, "statusOrder": { "type": "integer" }, "disabled": { "type": "boolean" }, "custom": { "type": "boolean" }, "linkedStages": { "type": "array", "items": { "type": "string" } }, "templates": { "type": "array", "items": { "$ref": "#/definitions/ConversationTemplateDeprecated" } }, "requirements": { "type": "array", "items": { "$ref": "#/definitions/WorkflowStatusRequirementDeprecated" } } } }, "ListMemberDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "globalUserId": { "type": "integer" }, "listId": { "type": "integer" }, "statusId": { "type": "integer" }, "statusLocked": { "type": "boolean" }, "customStatusId": { "type": "integer" }, "customStatus": { "$ref": "#/definitions/ListCustomStatusDeprecated" }, "customInfluencerStatusId": { "type": "integer" }, "optedIn": { "type": "boolean" }, "optedInDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date" }, "postedDate": { "type": "string", "format": "date" }, "engagements": { "type": "number" }, "concept": { "type": "string" }, "quote": { "type": "number" }, "participating": { "type": "boolean" }, "completed": { "type": "boolean" }, "instanceUser": { "$ref": "#/definitions/InstanceUserMaterializedView" } } }, "MembershipDeprecated": { "type": "object", "properties": { "id": { "description": "id and membershipId are equivalent.", "type": "integer" }, "membershipId": { "description": "id and membershipId are equivalent.", "type": "integer" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "membershipType": { "type": "string" }, "blacklisted": { "type": "boolean" }, "utmContent": { "type": "string" }, "utmCampaign": { "type": "string" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "pointsCurrentBalance": { "type": "object", "properties": { "amount": { "type": "integer" } } }, "totalPoints": { "type": "integer" }, "mostRecentActivationDate": { "type": "string", "format": "date" }, "totalImpressions": { "type": "number" }, "imageUrl": { "type": "string" }, "lifetimeClicks": { "type": "integer" }, "lifetimeConversions": { "type": "integer" }, "lifetimeConversionsValue": { "type": "number" } } }, "MembershipContactInfo": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string" }, "emailIsVerified": { "type": "boolean" }, "phone": { "type": "string" }, "street": { "type": "string" }, "apt": { "type": "string" }, "birthday": { "type": "string", "format": "date" }, "age": { "type": "integer" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "type": "string" }, "zip": { "type": "string" }, "gender": { "type": "string" }, "genderDescription": { "type": "string" } } }, "MembershipRejection": { "type": "object", "description": "Passed when an influencer does not meet the entrance criteria for the community.", "properties": { "redirectLink": { "type": "string" }, "rejectReason": { "type": "string" }, "missingCriteria": { "type": "array", "items": { "type": "string" } } } }, "Metric": { "type": "object", "properties": { "id": { "type": "integer" }, "displayName": { "type": "string" }, "name": { "type": "string" } } }, "PendingActivation": { "type": "object", "properties": { "id": { "type": "integer" }, "action": { "$ref": "#/definitions/ActionDeprecated" }, "blogContent": { "$ref": "#/definitions/BlogContent" }, "activations": { "description": "If the user has created any activations for this pending activation, then they are displayed here.", "type": "array", "items": { "$ref": "#/definitions/ActivationDeprecated" } } } }, "PowerReviewsAppDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "id of the power reviews app" }, "apiKey": { "type": "string", "description": "the power reviews api key" }, "environment": { "type": "string", "description": "the environment of the power reviews app" }, "merchantId": { "type": "string", "description": "the merchant id of the power reviews app" }, "name": { "type": "string", "description": "the name of the brand that belongs to the power reviews app" }, "locale": { "type": "string", "description": "the locale of the power reviews app" }, "communityId": { "type": "string", "description": "the community id of the power reviews app" } } }, "PowerReviewsPageDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "id of the product" }, "reviewProductId": { "type": "integer", "description": "the power reviews id" }, "powerReviewsAppId": { "type": "string", "description": "the product id" }, "externalPageId": { "type": "string", "description": "product image url" }, "PowerReviewsApp": { "type": "object", "items": { "$ref": "#/definitions/PowerReviewsAppDeprecated" } } } }, "PreviewPostDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "postId": { "type": "string" }, "network": { "type": "string" }, "likes": { "type": "integer" }, "comments": { "type": "integer" }, "views": { "type": "integer" }, "shares": { "type": "integer" }, "caption": { "type": "string" }, "imageUrl": { "type": "string" }, "link": { "type": "string" }, "isSponsored": { "type": "boolean" }, "mentions": { "type": "array", "items": { "type": "string" } }, "activation": { "$ref": "#/definitions/ActivationDeprecated" }, "postedTime": { "type": "string", "format": "date-time" }, "visualSafeSearch": { "$ref": "#/definitions/VisualSafeSearchDeprecated" }, "textSafeSearch": { "$ref": "#/definitions/TextSafeSearchDeprecated" } } }, "ProductDeprecated": { "type": "object", "properties": { "id": { "type": "integer", "description": "id of the product" }, "title": { "type": "string", "description": "title of the product" }, "description": { "type": "string", "description": "Description of product" }, "image": { "type": "string", "description": "product image url" }, "communityId": { "type": "string", "description": "instance to which this product belongs" }, "bazaarVoiceAppProduct": { "$ref": "#/definitions/BazaarVoiceAppProductDeprecated" }, "powerReviewsPage": { "$ref": "#/definitions/PowerReviewsPageDeprecated" }, "yotpoAppProduct": { "$ref": "#/definitions/YotpoAppProductDeprecated" } } }, "ReviewFormDeprecated": { "type": "object", "required": [ "questions" ], "properties": { "id": { "type": "integer", "description": "id of form" }, "reviewProductId": { "type": "integer" }, "action": { "$ref": "#/definitions/ActionDeprecated" }, "product": { "$ref": "#/definitions/ProductDeprecated" }, "questions": { "type": "array", "description": "Array of form questions", "items": { "$ref": "#/definitions/QuestionDeprecated" } }, "title": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "incentivized": { "x-access": [ "administrator", "root" ], "type": "boolean", "description": "whether the form is incentivized" }, "responses": { "type": "array", "x-access": [ "administrator", "root" ], "items": { "type": "object", "properties": { "membership": { "$ref": "#/definitions/MembershipDeprecated" }, "questionResponses": { "type": "array", "items": { "type": "object" } } } } } } }, "BulkFulfillOption": { "type": "object", "properties": { "optionType": { "type": "string", "enum": [ "CASH", "GIFT_CARD", "SHOPIFY_DISCOUNT", "PRODUCT", "PROMO_CODE", "OTHER", "OFFLINE" ] }, "providerAppExternalDescription": { "type": "string" }, "paymentAccountId": { "type": "number" }, "paymentAccountProvider": { "type": "string", "enum": [ "PAYPAL", "STRIPE", "TANGO_CARDS", "MAVELY", "TIPALTI" ] } } }, "EnrichedListMemberRewardWin": { "type": "object", "properties": { "listMemberId": { "type": "integer" }, "listId": { "type": "integer" }, "customStatusId": { "type": "integer" }, "currentStatusSlug": { "type": "string" }, "globalUserId": { "type": "integer" }, "actionGroupId": { "type": "integer" }, "communityId": { "type": "string" }, "listMemberRewardWins": { "type": "array", "items": { "type": "object", "properties": { "rewardWinId": { "type": "integer" }, "type": { "type": "string" }, "fulfillmentStatus": { "type": "string" }, "isFulfilled": { "type": "boolean" }, "fulfillmentStageSlug": { "type": "string" }, "statusUpdated": { "type": "boolean" }, "cashPaymentAppId": { "type": "integer" }, "giftCardOptionId": { "type": "integer" }, "cashPayment": { "type": "object", "properties": { "id": { "type": "integer" }, "cashPaymentStatus": { "type": "string" }, "paymentAccountTransactionId": { "type": "integer" }, "cashPaymentAppId": { "type": "integer" }, "externalId": { "type": "string" }, "providerSearchableTransactionId": { "type": "string" }, "value": { "type": "number" }, "chargeAmount": { "type": "number" }, "chargeCurrencyCode": { "type": "string" }, "valueCurrencyCode": { "type": "string" }, "recipientEmail": { "type": "string" } } }, "giftCardOrder": { "type": "object", "properties": { "id": { "type": "integer" }, "paymentAccountTransactionId": { "type": "integer" }, "giftCardOptionId": { "type": "integer" }, "giftCardAppId": { "type": "integer" }, "value": { "type": "number" }, "chargeAmount": { "type": "number" }, "chargeCurrencyCode": { "type": "string" }, "valueCurrencyCode": { "type": "string" }, "recipientEmail": { "type": "string" }, "externalId": { "type": "string" } } } } } } } }, "ListMemberRewardWin": { "type": "object", "properties": { "id": { "type": "integer" }, "membershipId": { "type": "integer" }, "rewardWinId": { "type": "integer" }, "listMemberId": { "type": "integer" }, "eligibleOnEventType": { "type": "string" }, "RewardWin": { "$ref": "#/definitions/RewardWin" }, "shopify": { "type": "object", "properties": { "couponActivation": { "type": "string" }, "couponRestriction": { "type": "string" }, "endsAt": { "type": [ "string", "null" ] }, "startsAt": { "type": [ "string", "null" ] }, "prefix": { "type": "string" }, "entitledCollectionIds": { "type": "array", "items": { "type": "integer" } }, "entitledProductIds": { "type": "array", "items": { "type": "integer" } } } } } }, "RewardWin": { "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier for a reward win." }, "influencerId": { "type": "integer" }, "influencerFirstName": { "type": "string" }, "influencerLastName": { "type": "string" }, "influencerEmail": { "type": "string" }, "influencerAddress": { "type": "string" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "source": { "type": "string", "description": "How this RewardWin was generated, e.g. incentive or spot." }, "incentive": { "$ref": "#/definitions/IncentiveDeprecated" }, "rewardTitle": { "type": "string", "description": "Title for the associated reward." }, "rewardImage": { "type": "string", "description": "Image of the associated reward." }, "orderNumber": { "type": "string", "description": "For physically-fulfilled rewards, this contains the order number for tracking purposes." }, "trackingNumber": { "type": "string", "description": "For physically-fulfilled rewards, this contains the tracking number of the order." }, "comment": { "type": "string", "description": "Any custom comment associated with this reward win." }, "verifiedAddress": { "type": "boolean", "description": "A flag to track whether an administrator has verified this influencer's email or postal address, depending on the delivery method of the reward." }, "isFulfilled": { "type": "boolean", "description": "A flag informing whether this reward win has been fulfilled yet." }, "isArchived": { "type": "boolean", "description": "A flag informing whether this reward win has been archived. An fulfilled reward win cannot be archived." }, "fulfilledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "If the reward win has been fulfilled, this will display the time at which fulfillment occurred." }, "fulfilledBy": { "type": "string", "description": "If the reward win has been fulfilled, this will display the account email of the user who fulfilled it." }, "fulfillmentStatus": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "number" }, "valueCurrencyCode": { "type": "string" }, "cost": { "type": "number" }, "costCurrencyCode": { "type": "string" }, "description": { "type": "string" }, "createdBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "lastModifiedBy": { "$ref": "#/definitions/AdministratorDeprecated" }, "cashPayment": { "type": "object", "properties": { "externalId": { "type": "string" }, "id": { "type": "integer" } } }, "giftCardOrder": { "type": "object", "properties": { "externalId": { "type": "string" }, "id": { "type": "integer" } } }, "giftCardOption": { "type": "object", "properties": { "id": { "type": "integer" } } }, "cashPaymentApp": { "type": "object", "properties": { "id": { "type": "integer" }, "provider": { "type": "string", "description": "The cash payment app provider of the reward win." } } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "readiedAt": { "type": "string", "format": "date-time" }, "completedDate": { "type": "string", "format": "date-time" }, "actionGroup": { "$ref": "#/definitions/ActionGroupDeprecated" }, "user": { "$ref": "#/definitions/GlobalUserDeprecated" }, "cashPaymentAppId": { "type": [ "integer", "null" ], "description": "ID the associated cash payment app." }, "giftCardOptionId": { "type": [ "integer", "null" ], "description": "ID the associated gift card option." }, "giftCardEmailTemplateId": { "type": [ "string", "null" ], "description": "ID the associated gift card email template (External Id)." }, "listMemberRewardWin": { "type": "object", "properties": { "id": { "type": "integer" }, "listMemberId": { "type": "integer" }, "eligibleOnEventType": { "type": "string" } } }, "communityId": { "type": "string", "description": "The communityId of the reward win." }, "mostRecentTransaction": { "$ref": "#/definitions/PaymentsLedger" }, "discountCodeId": { "type": [ "string", "null" ], "description": "Discount ID for SHOPIFY_DISCOUNT type rewards" }, "discountCodeRedeemId": { "type": [ "string", "null" ], "description": "ID of shopify transaction where a SHOPIFY_DISCOUNT was used" }, "shippingCodeId": { "type": [ "string", "null" ], "description": "Shipping ID for SHOPIFY_DISCOUNT type rewards" }, "shippingCodeRedeemId": { "type": [ "string", "null" ], "description": "ID of shopify transaction where a SHOPIFY_DISCOUNT shipping code was used" }, "couponActivation": { "type": [ "string", "null" ], "description": "Coupon Activation for SHOPIFY_DISCOUNT type rewards" }, "incentiveId": { "type": [ "string", "null" ], "description": "The incentive ID associated with the reward win if used." }, "invoiceNumber": { "type": [ "string", "null" ], "description": "Invoice number for the reward win" }, "taxId": { "type": [ "string", "null" ], "description": "Tax ID for the reward win" }, "bonusTierCurrencyCode": { "type": [ "string", "null" ] }, "bonusTiers": { "type": [ "array", "null" ], "description": "Sorted tiered bonus payout ladder", "items": { "$ref": "#/definitions/BonusTier" } }, "attainedBonusTierIndex": { "type": [ "integer", "null" ], "description": "Zero-based index of the tier attained when this reward win was fulfilled" }, "taxLineItems": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of the tax item: GST, HST, VAT, PST, QST" }, "amount": { "type": "number", "description": "Amount of the tax item" } } } } } }, "RewardWinMetadata": { "type": "object", "properties": { "totalCount": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "pending": { "type": "number" }, "ready": { "type": "number" }, "fulfilled": { "type": "number" }, "rejected": { "type": "number" } } }, "TikTokCreatorDeprecated": { "type": "object", "properties": { "displayName": { "type": "string" }, "followersCount": { "type": "integer" }, "globalUserId": { "type": "integer" }, "handleName": { "type": "string" }, "insightsUpdatedAt": { "type": "string", "format": "date-time" }, "isActive": { "type": "boolean" }, "profileImage": { "type": "string" }, "status": { "type": "string" }, "tiktokAccessGrant": { "type": "object" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "audiencePredominantDevice": { "type": "string" }, "audiencePredominantGender": { "type": "string" }, "audiencePredominantLocale": { "type": "string" } } }, "TrackingLinkDeprecated": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "title": { "type": "string" }, "communityId": { "type": "string" }, "url": { "type": "string" }, "shortLink": { "type": "string" }, "trackingPixelCode": { "type": "string" }, "conversionId": { "type": "string", "description": "Assign a conversion to track conversions resulting from clicks on this link." }, "domainId": { "type": "string" }, "domain": { "type": "string" }, "type": { "type": "string" }, "numClicks": { "type": "integer" }, "lastUpdated": { "type": "string" }, "isDeleted": { "type": "string" }, "membershipId": { "type": "string" }, "conversions": { "type": "integer" }, "conversionsValue": { "type": "number" }, "providerCode": { "type": "string" }, "providerName": { "type": "string" }, "isAffiliate": { "type": "boolean" }, "action": { "$ref": "#/definitions/ActionDeprecated" }, "destinationUrl": { "type": "string", "description": "A user will ultimately be redirected to this url when someone clicks on the link contained in an artifact on a network." }, "metaInformation": { "$ref": "#/definitions/MetaInformationDeprecated" } } }, "AudienceInsights": { "type": "object", "properties": { "DemographicsPro_Audience_Gender_Max": { "type": "string" }, "DemographicsPro_Audience_MaritalStatus_Max": { "type": "string" }, "DemographicsPro_Audience_ParentalStatus_Max": { "type": "string" }, "DemographicsPro_Audience_Age_Max": { "type": "string" }, "DemographicsPro_Audience_Race_Max": { "type": "string" }, "DemographicsPro_Audience_Language_Max": { "type": "string" }, "DemographicsPro_Audience_Country_Max": { "type": "string" }, "DemographicsPro_Audience_State_Max": { "type": "string" }, "DemographicsPro_Audience_City_Max": { "type": "string" }, "DemographicsPro_Audience_EducationStatus_Max": { "type": "string" }, "DemographicsPro_Audience_EducationOrganization_Max": { "type": "string" }, "DemographicsPro_Audience_Occupation_Max": { "type": "string" }, "DemographicsPro_Audience_Industry_Max": { "type": "string" }, "DemographicsPro_Audience_Employer_Max": { "type": "string" }, "DemographicsPro_Audience_PersonalIncome_Max": { "type": "string" }, "DemographicsPro_Audience_LikesAndInterests_Max": { "type": "string" }, "DemographicsPro_Audience_PeopleInfluences_Max": { "type": "string" }, "DemographicsPro_Audience_MediaInfluences_Max": { "type": "string" }, "DemographicsPro_Audience_BrandInfluences_Max": { "type": "string" }, "DemographicsPro_Audience_Favorite_MusicGenre_Max": { "type": "string" }, "DemographicsPro_Audience_Favorite_MusicSoloArtist_Max": { "type": "string" }, "DemographicsPro_Audience_Favorite_MusicBands_Max": { "type": "string" }, "DemographicsPro_Audience_SportsFollowed_Max": { "type": "string" }, "DemographicsPro_Audience_SportTeamSupported_Max": { "type": "string" }, "DemographicsPro_Audience_BrandInfluences_All": { "type": "string" }, "DemographicsPro_Audience_Country_All": { "type": "string" }, "DemographicsPro_Audience_Gender_All": { "type": "string" }, "DemographicsPro_Audience_Age_All": { "type": "string" }, "DemographicsPro_Audience_Race_All": { "type": "string" }, "DemographicsPro_Audience_Language_All": { "type": "string" } } }, "GlobalUserDeprecated": { "type": "object", "properties": { "id": { "type": [ "integer", "string" ] }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePicture": { "type": "string" }, "unverified": { "type": "string", "enum": [ "hidden", "emails", "excludes" ] }, "country": { "type": "string", "enum": [ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Caribbean Netherlands", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Collectivity of Saint Martin", "Colombia", "Comoros", "Cook Islands", "Costa Rica", "Côte d'Ivoire", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Federated States of Micronesia", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Jamaica", "Japan", "Italy", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia (FYROM)", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of the Congo", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Saint-Barthélemy", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States Minor Outlying Islands", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ] }, "state": { "type": "string" }, "city": { "type": "string" }, "zip": { "type": "string" }, "street": { "type": "string" }, "apt": { "type": "string" }, "phone": { "type": "string" }, "age": { "type": "integer" }, "gender": { "type": "string", "enum": [ "male", "female", "other", "non_bin", "describe" ] }, "email": { "type": "string" }, "talentManagerEmail": { "type": "string" }, "registered": { "type": "boolean" }, "birthday": { "type": "string", "format": "date" }, "facebookProfile": { "$ref": "#/definitions/FacebookProfileDeprecated" }, "instagramAccount": { "$ref": "#/definitions/InstagramAccountDeprecated" }, "instagramProfile": { "$ref": "#/definitions/InstagramProfileDeprecated" }, "tiktokCreator": { "$ref": "#/definitions/TikTokCreatorDeprecated" }, "twitterAccount": { "$ref": "#/definitions/TwitterAccountDeprecated" }, "pinterestAccount": { "$ref": "#/definitions/PinterestAccountDeprecated" }, "youtubeChannel": { "$ref": "#/definitions/YoutubeChannelDeprecated" }, "blog": { "$ref": "#/definitions/Blog" }, "lists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "label": { "type": "string" } } } }, "appMembership": { "$ref": "#/definitions/MembershipDeprecated" }, "userContactInfo": { "type": "object", "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "emailIsVerified": { "type": "boolean" }, "referralSlug": { "type": "string" }, "referralCount": { "type": "string" }, "gender": { "type": "string" }, "genderDescription": { "type": "string" } } }, "influencerTopics": { "type": "array", "items": { "$ref": "#/definitions/TopicDeprecated" } }, "previewPosts": { "type": "array", "items": { "$ref": "#/definitions/PreviewPostDeprecated" } }, "activations": { "type": "integer" }, "engagements": { "type": "integer" }, "clicksCount": { "type": "integer" }, "conversionCount": { "type": "integer" }, "conversionValue": { "type": "number", "format": "double" }, "rewards": { "type": "integer" }, "facebookPostsCount": { "type": "integer" }, "instagramPostsCount": { "type": "integer" }, "twitterPostsCount": { "type": "integer" }, "pinterestPostsCount": { "type": "integer" }, "membershipDataPoints": { "type": "array", "items": { "type": "object", "properties": { "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinitionDeprecated" }, "lastEditedBy": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "value": { "type": "array", "items": { "type": "string" } } } } }, "membershipCostAndPerformance": { "$ref": "#/definitions/MembershipCostAndPerformanceDeprecated" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePercentageFemale": { "type": "number" }, "audiencePercentage_13_17": { "type": "number" }, "audiencePercentage_18_24": { "type": "number" }, "audiencePercentage_25_34": { "type": "number" }, "audiencePercentage_35_44": { "type": "number" }, "audiencePercentage_45_54": { "type": "number" }, "audiencePercentage_55_64": { "type": "number" }, "audiencePercentage_65_plus": { "type": "number" }, "cpe": { "type": "number" }, "cpm": { "type": "number" }, "cpp": { "type": "number" }, "audienceFraudLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "audienceFakeFollowersLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "audienceFakeEngagersLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "nudityLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "violenceLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "profanityLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "hasPublicSummaryRecord": { "type": "boolean" } } }, "InstanceUserMaterializedView": { "type": "object", "properties": { "communityId": { "type": "string" }, "lifetimeImpressions": { "type": "integer" }, "lifetimeClicks": { "type": "integer" }, "lifetimeConversions": { "type": "integer" }, "lifetimeValue": { "type": "number" }, "blogName": { "type": "string" }, "facebookFollowersCount": { "type": "integer" }, "facebookName": { "type": "string" }, "facebookPicture": { "type": "string" }, "facebookAverageEngagements": { "type": "integer" }, "facebookEngagementRate": { "type": "number" }, "globalUserId": { "type": [ "integer", "string" ] }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "type": "string", "enum": [ "male", "female", "other", "non_bin", "describe" ] }, "country": { "type": "string", "enum": [ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Caribbean Netherlands", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Collectivity of Saint Martin", "Colombia", "Comoros", "Cook Islands", "Costa Rica", "Côte d'Ivoire", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Federated States of Micronesia", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Jamaica", "Japan", "Italy", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia (FYROM)", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of the Congo", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Saint-Barthélemy", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States Minor Outlying Islands", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ] }, "state": { "type": "string" }, "city": { "type": "string" }, "zip": { "type": "string" }, "birthday": { "type": "string", "format": "date" }, "phone": { "type": "string" }, "audiencePercentage_13_17": { "type": "number" }, "audiencePercentage_18_24": { "type": "number" }, "audiencePercentage_25_34": { "type": "number" }, "audiencePercentage_35_44": { "type": "number" }, "audiencePercentage_45_54": { "type": "number" }, "audiencePercentage_55_64": { "type": "number" }, "audiencePercentage_65_plus": { "type": "number" }, "audiencePercentageFemale": { "type": "number" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audienceFraudLevel": { "type": "string", "enum": [ "low", "medium", "high" ] }, "cpm": { "type": "number" }, "cpe": { "type": "number" }, "cpp": { "type": "number" }, "instagramHandle": { "type": "string" }, "instagramFullName": { "type": "string" }, "instagramProfilePicture": { "type": "string" }, "instagramFollowersCount": { "type": "integer" }, "instagramAverageEngagements": { "type": "integer" }, "instagramEngagementRate": { "type": "number" }, "membershipId": { "description": "id and membershipId are equivalent.", "type": "integer" }, "status": { "type": "string" }, "pinterestUsername": { "type": "string" }, "pinterestFollowersCount": { "type": "integer" }, "pinterestMonthlyViewers": { "type": "integer" }, "twitterHandle": { "type": "string" }, "twitterFollowersCount": { "type": "integer" }, "twitterEngagementRate": { "type": "number" } } }, "UserQueryFilter": { "type": "object", "required": [ "expectedNumberOfInfluencers" ], "properties": { "userFilter": { "$ref": "#/definitions/UserSearch" }, "q": { "type": "string", "description": "Search parameter." }, "excludedGlobalUserIds": { "type": "array", "items": { "type": "integer" } }, "expectedNumberOfInfluencers": { "type": "integer" }, "searchKeywords": { "type": "string" }, "orderProperty": { "type": "string", "enum": [ "createdAt", "id", "age", "audienceFakeEngagersLevel", "audienceFakeFollowersLevel", "audienceFraudLevel", "audiencePercentageFemale", "audiencePercentage_13_17", "audiencePercentage_18_24", "audiencePercentage_25_34", "audiencePercentage_35_44", "audiencePercentage_45_54", "audiencePercentage_55_64", "audiencePercentage_65_plus", "audiencePredominantAgeRange", "audiencePredominantCity", "audiencePredominantCountry", "birthday", "city", "country", "deleted", "email", "fullName", "gender", "instagramHandle", "lastRefreshedAt", "loadSource", "nudityLevel", "profanityLevel", "state", "violenceLevel", "instagramAccount.globalUserId", "instagramAccount.analysisVersion", "instagramAccount.audienceFakeCommentersLevel", "instagramAccount.audienceFakeCommentersPercentage", "instagramAccount.audienceFakeEngagersLevel", "instagramAccount.audienceFakeFollowersLevel", "instagramAccount.audienceFakeFollowersPercentage", "instagramAccount.audienceFakeLikersLevel", "instagramAccount.audienceFakeLikersPercentage", "instagramAccount.audienceFraudLevel", "instagramAccount.audiencePercentageFemale", "instagramAccount.audiencePercentage_13_17", "instagramAccount.audiencePercentage_18_24", "instagramAccount.audiencePercentage_25_34", "instagramAccount.audiencePercentage_35_44", "instagramAccount.audiencePercentage_45_54", "instagramAccount.audiencePercentage_55_64", "instagramAccount.audiencePercentage_65_plus", "instagramAccount.audiencePredominantAgeRange", "instagramAccount.audiencePredominantCity", "instagramAccount.audiencePredominantCountry", "instagramAccount.averageComments", "instagramAccount.averageEngagements", "instagramAccount.averageLikes", "instagramAccount.bio", "instagramAccount.boughtFollowers", "instagramAccount.createdAt", "instagramAccount.engagementRate", "instagramAccount.followersCount", "instagramAccount.followingCount", "instagramAccount.fullName", "instagramAccount.handle", "instagramAccount.instagramExternalId", "instagramAccount.instagramProfileId", "instagramAccount.isBusiness", "instagramAccount.isPrivate", "instagramAccount.lastAnalyzedAt", "instagramAccount.lastAnalyzedFollowersFraudAt", "instagramAccount.loadSource", "instagramAccount.mediaCount", "instagramAccount.nudityLevel", "instagramAccount.previewPostsLastUpdatedAt", "instagramAccount.profanityLevel", "instagramAccount.profilePicture", "instagramAccount.profileType", "instagramAccount.sourceDetail", "instagramAccount.sponsoredPostRate", "instagramAccount.topicsLastAnalyzedAt", "instagramAccount.updatedAt", "instagramAccount.violenceLevel", "instagramAccount.website", "facebookProfile.id", "facebookProfile.averageComments", "facebookProfile.averageEngagements", "facebookProfile.averageLikes", "facebookProfile.engagementRate", "facebookProfile.facebookExternalId", "facebookProfile.facebookCreator", "facebookProfile.link", "facebookProfile.name", "facebookProfile.picture", "facebookProfile.reach", "facebookProfile.type", "twitterAccount.id", "twitterAccount.userId", "twitterAccount.handle", "twitterAccount.fullName", "twitterAccount.profilePicture", "twitterAccount.description", "twitterAccount.followersCount", "twitterAccount.followingCount", "twitterAccount.listedCount", "twitterAccount.accountCreatedAt", "twitterAccount.location", "twitterAccount.geoEnabled", "twitterAccount.lang", "twitterAccount.timeZone", "twitterAccount.utcOffset", "twitterAccount.verified", "twitterAccount.protected", "twitterAccount.averageFavorites", "twitterAccount.averageRetweets", "twitterAccount.averageEngagements", "twitterAccount.engagementRate", "twitterAccount.primaryAccount", "twitterAccount.twitterExternalId", "twitterAccount.createdAt", "pinterestAccount.id", "pinterestAccount.averageEngagements", "pinterestAccount.bio", "pinterestAccount.boardsCount", "pinterestAccount.createdAt", "pinterestAccount.engagementRate", "pinterestAccount.externalId", "pinterestAccount.firstName", "pinterestAccount.followersCount", "pinterestAccount.followingCount", "pinterestAccount.lastName", "pinterestAccount.monthlyViewers", "pinterestAccount.pinsCount", "pinterestAccount.primaryAccount", "pinterestAccount.profilePicture", "pinterestAccount.updatedAt", "pinterestAccount.userId", "pinterestAccount.username", "blog.id", "blog.globalUserId", "blog.language", "blog.name", "blog.platform", "blog.url", "youtubeChannel.id", "youtubeChannel.userId", "youtubeChannel.username", "youtubeChannel.bio", "youtubeChannel.accountCreatedAt", "youtubeChannel.profilePicture", "youtubeChannel.followersCount", "youtubeChannel.videoCount", "youtubeChannel.commentCount", "youtubeChannel.viewCount", "youtubeChannel.primaryAccount", "youtubeChannel.youtubeExternalId", "youtubeChannel.handle", "youtubeChannel.global_user_id", "user.stageJoinDate" ] } } }, "UserSearch": { "type": "object", "additionalProperties": false, "properties": { "DemographicsPro_Audience_Data_Analysis": { "type": "object", "additionalProperties": false, "properties": { "DemographicsPro_Audience_Gender_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_MaritalStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_ParentalStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Age_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Race_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Language_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Country_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_State_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_City_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_EducationStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_PersonalIncome_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Occupation_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Industry_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Employer_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_EducationOrganization_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_LikesAndInterests_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_PeopleInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_MediaInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_BrandInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicGenre_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicSoloArtist_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicBands_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_SportsFollowed_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_SportTeamSupported_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_BrandInfluences_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Country_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Gender_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Age_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Race_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Language_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } } } }, "DemographicsPro_Audience_Data_Analysis_Facebook": { "type": "object", "additionalProperties": false, "properties": { "DemographicsPro_Audience_Gender_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Country_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_City_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Age_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } } } }, "DemographicsPro_Audience_Data_Analysis_TikTok": { "type": "object", "additionalProperties": false, "properties": { "DemographicsPro_Audience_Gender_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_MaritalStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_ParentalStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Age_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Race_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Language_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Country_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_State_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_City_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_EducationStatus_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_PersonalIncome_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Occupation_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Industry_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Employer_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_EducationOrganization_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_LikesAndInterests_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_PeopleInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_MediaInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_BrandInfluences_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicGenre_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicSoloArtist_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Favorite_MusicBands_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_SportsFollowed_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_SportTeamSupported_Max": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_Gender_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Age_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Race_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Language_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_Country_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } }, "range": { "type": "object", "additionalProperties": false, "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "DemographicsPro_Audience_State_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "DemographicsPro_Audience_City_All": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } } } }, "DemographicsPro_Audience_Data_Analysis_Snapchat": { "type": "object", "additionalProperties": false, "properties": { "DemographicsPro_Audience_Age_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Country_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "DemographicsPro_Audience_Gender_Max": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } } } }, "memberSelectedEthnicities": { "type": "object", "additionalProperties": false, "properties": { "ethnicGroup": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } } } }, "dataPoints": { "type": "object", "x-filter-type": "terms" }, "instagramAccount": { "type": "object", "additionalProperties": false, "properties": { "isBusiness": { "type": "boolean", "x-filter-type": "boolean" }, "isPrivate": { "type": "boolean", "x-filter-type": "boolean" }, "handle": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageLikes": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageComments": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageEngagements": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "facebookProfile": { "type": "object", "additionalProperties": false, "properties": { "reach": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageLikes": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageComments": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageEngagements": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "tiktokCreator": { "type": "object", "additionalProperties": false, "properties": { "status": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantAgeRange": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantCountry": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantDevice": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantGender": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantLocale": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "accountType": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "Business", "Brand", "Creator", "Influencer" ] } }, "twitterAccount": { "type": "object", "additionalProperties": false, "properties": { "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageFavorites": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageRetweets": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageEngagements": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "pinterestAccount": { "type": "object", "additionalProperties": false, "properties": { "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "monthlyViewers": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "averageEngagements": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "boardsCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "pinsCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "appMembership": { "type": "object", "additionalProperties": false, "properties": { "totalImpressions": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "lifetimeClicks": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "lifetimeConversions": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "lifetimeConversionsValue": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "mostRecentActivationDate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "string", "format": "date" } } } } }, "registeredInfluencer": { "type": "object", "additionalProperties": false }, "hasPosted": { "type": "object", "additionalProperties": false }, "blog": { "type": "object", "x-filter-type": "exists", "additionalProperties": false }, "youtubeChannel": { "type": "object", "x-filter-type": "exists", "additionalProperties": false, "properties": { "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "snapchatAccount": { "type": "object", "x-filter-type": "exists", "additionalProperties": false, "properties": { "followersCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "engagementRate": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "profileTier": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "TIER_STANDARD", "TIER_PUBLIC_OFFICIAL", "TIER_PUBLIC" ] } }, "profileType": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "Emerging Creator", "Snap Star", "Business", "Official Business" ] } }, "shareAuthorizedDataWithApiPartners": { "type": "boolean", "additionalProperties": false, "x-filter-type": "boolean" } } }, "customInfluencerStatusId": { "type": "object", "additionalProperties": true }, "dueDate": { "type": "object", "additionalProperties": true }, "audienceLocation": { "type": "object", "x-filter-type": "$or", "additionalProperties": false, "properties": { "audiencePredominantCity": { "type": "array", "items": { "type": "string" } }, "audiencePredominantCountry": { "type": "array", "items": { "type": "string" } } } }, "hasSponsoredContent": { "type": "object", "x-filter-type": "$or", "properties": { "instagramPost.isSponsored": { "type": "array", "items": { "type": "boolean" } }, "tiktokPosts.isSponsored": { "type": "array", "items": { "type": "boolean" } } } }, "globalPerformanceComposites": { "type": "array", "items": { "type": "object", "properties": { "fields": { "type": "array", "items": { "type": "string", "enum": [ "emv", "roi", "cpp", "cpe", "cpm", "sponsoredContentEmv", "sponsoredContentRoi", "sponsoredContentCpp", "sponsoredContentCpe", "sponsoredContentCpm" ] } }, "payload": { "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } } }, "globalPerformanceMetrics": { "type": "object", "additionalProperties": false, "properties": { "emv": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "roi": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpp": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpe": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpm": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "sponsoredContentEmv": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "sponsoredContentRoi": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "sponsoredContentCpp": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "sponsoredContentCpe": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "sponsoredContentCpm": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "costPerMavelyLinkClick": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "hasTrackingOrAffiliateLinksData": { "type": "boolean", "additionalProperties": false, "x-filter-type": "boolean" }, "brandsCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "campaignsCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "boundContentCount": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } } } }, "city": { "type": "string", "x-filter-type": "text" }, "unverified": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "hidden", "emails", "excludes" ] } }, "country": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Caribbean Netherlands", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Collectivity of Saint Martin", "Colombia", "Comoros", "Cook Islands", "Costa Rica", "Côte d'Ivoire", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Federated States of Micronesia", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Jamaica", "Japan", "Italy", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia (FYROM)", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of the Congo", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Saint-Barthélemy", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States Minor Outlying Islands", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ] } }, "gender": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "male", "female", "other", "non_bin", "describe" ] } }, "state": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "zip": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantCountry": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantAgeRange": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audiencePredominantCity": { "type": "array", "x-filter-type": "term", "items": { "type": "string" } }, "audienceFraudLevel": { "type": "array", "x-filter-type": "term", "items": { "type": "string", "enum": [ "low", "medium", "high" ] } }, "age": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "birthday": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "audiencePercentageFemale": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpe": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpm": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "cpp": { "type": "object", "additionalProperties": false, "x-filter-type": "range", "properties": { "$gte": { "type": "number" }, "$lte": { "type": "number" } } }, "lists": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } }, "topics": { "type": "object", "additionalProperties": false, "x-filter-type": "multiTerm", "properties": { "quantifier": { "type": "string", "enum": [ "any", "all" ] }, "ids": { "type": "array", "items": { "type": [ "integer", "string" ] } } } } } }, "WorkflowActionGroupPerformanceForecast": { "type": "object", "properties": { "count": { "type": "integer" }, "forecastedImpressions": { "type": "integer" }, "forecastedEngagements": { "type": "integer" }, "forecastedFollowers": { "type": "integer" }, "forecastedImpressionEngagementRate": { "type": "number" }, "forecastedFollowerEngagementRate": { "type": "number" }, "forecastedCost": { "type": "number" }, "forecastedCPE": { "type": "number" }, "forecastedCPM": { "type": "number" } } }, "WorkflowStatusBuckets": { "type": "object", "properties": { "id": { "type": "integer" }, "total": { "type": "integer" }, "accepted": { "type": "integer" }, "applicants": { "type": "integer" }, "candidates": { "type": "integer" }, "completed": { "type": "integer" }, "participants": { "type": "integer" }, "pending": { "type": "integer" }, "rejected": { "type": "integer" } } }, "WorkflowStatusSummary": { "type": "object", "properties": { "slug": { "type": "string" }, "ctaLabel": { "type": "string" }, "auxiliaryLabel": { "type": "string" }, "label": { "type": "string" }, "enabled": { "type": "string" }, "count": { "type": "integer" }, "sortOrder": { "type": "integer" }, "statusId": { "type": "integer" }, "phase": { "type": "string" } } }, "YotpoAppProductDeprecated": { "type": "object", "properties": { "reviewProductId": { "type": "integer", "description": "Product id assigned by Mavrck" }, "yotpoProductId": { "type": "string", "description": "Product id assigned by Yotpo" } } }, "BadRequestError": { "properties": { "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" }, "message": { "type": "string", "enum": [ "Bad Request" ], "x-nullable": false } }, "required": [ "message" ], "type": "object", "additionalProperties": false }, "ForbiddenError": { "properties": { "message": { "type": "string", "enum": [ "Access Forbidden" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "ServerError": { "properties": { "message": { "type": "string", "enum": [ "Server Error" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "NotFoundError": { "properties": { "message": { "type": "string", "enum": [ "Resource Not Found" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "ValidateErrorJSON": { "properties": { "message": { "type": "string", "enum": [ "Validation failed" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "Framework.BadRequestError": { "properties": { "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" }, "message": { "type": "string", "enum": [ "Bad Request" ], "x-nullable": false } }, "required": [ "message" ], "type": "object", "additionalProperties": false }, "Framework.ForbiddenError": { "properties": { "message": { "type": "string", "enum": [ "Access Forbidden" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "Framework.NotFoundError": { "properties": { "message": { "type": "string", "enum": [ "Resource Not Found" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "Framework.ServerError": { "properties": { "message": { "type": "string", "enum": [ "Server Error" ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "Schema": { "properties": { "id": { "type": "string" }, "$schema": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "multipleOf": { "type": "number", "format": "double" }, "maximum": { "type": "number", "format": "double" }, "exclusiveMaximum": { "type": "boolean" }, "minimum": { "type": "number", "format": "double" }, "exclusiveMinimum": { "type": "boolean" }, "maxLength": { "type": "number", "format": "double" }, "minLength": { "type": "number", "format": "double" }, "pattern": { "type": "string" }, "additionalItems": { "type": "object" }, "items": { "type": "object" }, "maxItems": { "type": "number", "format": "double" }, "minItems": { "type": "number", "format": "double" }, "uniqueItems": { "type": "boolean" }, "maxProperties": { "type": "number", "format": "double" }, "minProperties": { "type": "number", "format": "double" }, "required": { "items": { "type": "string" }, "type": "array" }, "additionalProperties": { "type": "object" }, "definitions": { "properties": {}, "additionalProperties": { "$ref": "#/definitions/Schema" }, "type": "object" }, "properties": { "properties": {}, "additionalProperties": { "$ref": "#/definitions/Schema" }, "type": "object" }, "patternProperties": { "properties": {}, "additionalProperties": { "$ref": "#/definitions/Schema" }, "type": "object" }, "dependencies": { "properties": {}, "additionalProperties": { "type": "object" }, "type": "object" }, "enum": { "items": { "additionalProperties": true }, "type": "array" }, "type": { "type": "object" }, "allOf": { "items": { "$ref": "#/definitions/Schema" }, "type": "array" }, "anyOf": { "items": { "$ref": "#/definitions/Schema" }, "type": "array" }, "oneOf": { "items": { "$ref": "#/definitions/Schema" }, "type": "array" }, "not": { "$ref": "#/definitions/Schema" } }, "type": "object", "additionalProperties": false }, "ValidationError": { "properties": { "property": { "type": "string" }, "message": { "type": "string" }, "schema": { "type": "object" }, "instance": { "additionalProperties": true }, "name": { "type": "string" }, "argument": { "additionalProperties": true } }, "required": [ "property", "message", "schema", "instance", "name", "argument" ], "type": "object", "additionalProperties": false }, "UnprocessableContent": { "properties": { "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" }, "message": { "type": "string", "enum": [ "Unprocessable Content" ], "x-nullable": false } }, "required": [ "message" ], "type": "object", "additionalProperties": false }, "Gender": { "enum": [ "describe", "female", "male", "non_bin", "other" ], "type": "string" }, "MembershipContactInfoDeprecated": { "properties": { "age": { "type": "number", "format": "double" }, "apt": { "type": "string" }, "birthday": { "type": "object" }, "city": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "emailIsVerified": { "type": "boolean" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "genderDescription": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" }, "talentManagerEmail": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Membership": { "properties": { "blacklisted": { "type": "boolean" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "createdAt": { "type": "string" }, "id": { "type": "number", "format": "double" }, "imageUrl": { "type": "string" }, "lifetimeClicks": { "type": "number", "format": "double" }, "lifetimeConversions": { "type": "number", "format": "double" }, "lifetimeConversionsValue": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "membershipType": { "type": "string" }, "mostRecentActivationDate": { "type": "string" }, "pointsCurrentBalance": { "properties": { "amount": { "type": "number", "format": "double" } }, "type": "object" }, "status": { "type": "string" }, "totalImpressions": { "type": "number", "format": "double" }, "totalPoints": { "type": "number", "format": "double" }, "updatedAt": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "fullName": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Blog": { "properties": { "globalUserId": { "type": "number", "format": "double", "x-nullable": true }, "language": { "type": "string", "x-nullable": true }, "name": { "type": "string", "x-nullable": true }, "platform": { "type": "string", "x-nullable": true }, "url": { "type": "string", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "FacebookProfile": { "properties": { "active": { "type": "boolean" }, "available": { "type": "boolean" }, "averageComments": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "averageLikes": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "expiresAt": { "type": "string" }, "facebookUser": { "properties": { "isExpired": { "type": "boolean" } }, "type": "object" }, "facebookExternalId": { "type": "string" }, "id": { "type": "number", "format": "double" }, "link": { "type": "string" }, "name": { "type": "string" }, "username": { "type": "string" }, "picture": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "type": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Topic": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" } }, "type": "object", "additionalProperties": false }, "InstagramAccount": { "properties": { "averageComments": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "averageLikes": { "type": "number", "format": "double" }, "bio": { "type": "string" }, "engagementRate": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "followingCount": { "type": "number", "format": "double" }, "fullName": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "string", "enum": [ "number" ], "x-nullable": false }, "instagramAccessGrant": { "properties": { "type": { "type": "string" }, "businessIsExpired": { "type": "boolean" }, "platformIsExpired": { "type": "boolean" }, "isExpired": { "type": "boolean" } }, "type": "object" }, "accessGrant": { "properties": { "type": { "type": "string" }, "isExpired": { "type": "boolean" } }, "type": "object" }, "isBusiness": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "mediaCount": { "type": "number", "format": "double" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "profileType": { "type": "string", "enum": [ "platform", "business" ], "x-nullable": false }, "sponsoredPostRate": { "type": "number", "format": "double" }, "website": { "type": "string" } }, "type": "object", "additionalProperties": false }, "InstagramAudienceAuthenticityRequest": { "properties": { "id": { "type": "number", "format": "double" }, "instagramProfileId": { "type": "number", "format": "double" }, "requestId": { "type": "number", "format": "double" }, "requestStatus": { "type": "string" }, "requestErrorCode": { "type": "string" }, "requestResponse": { "additionalProperties": false, "type": "object" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "InstagramContentWarningRequest": { "properties": { "id": { "type": "number", "format": "double" }, "instagramExternalId": { "type": "string" }, "instagramProfileId": { "type": "number", "format": "double" }, "postId": { "type": "string" }, "displayUrl": { "type": "string" }, "requestStatus": { "type": "string" }, "requestErrorCode": { "type": "string" }, "requestResponse": { "additionalProperties": false, "type": "object" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "caption": { "type": "string" }, "postedTime": { "type": "string", "format": "date-time" } }, "type": "object", "additionalProperties": false }, "InstagramProfile": { "properties": { "accessGrant": { "properties": { "type": { "type": "string", "enum": [ "basic", "business" ], "x-nullable": false }, "isExpired": { "type": "boolean" } }, "type": "object" }, "audienceAuthenticity": { "$ref": "#/definitions/InstagramAudienceAuthenticityRequest" }, "audienceFakeCommentersLevel": { "type": "string" }, "audienceFakeCommentersPercentage": { "type": "number", "format": "double" }, "audienceFakeEngagersLevel": { "type": "string" }, "audienceFakeFollowersLevel": { "type": "string" }, "audienceFakeFollowersPercentage": { "type": "number", "format": "double" }, "audienceFakeLikersLevel": { "type": "string" }, "audienceFakeLikersPercentage": { "type": "number", "format": "double" }, "audienceFraudLevel": { "type": "string" }, "audiencePercentageFemale": { "type": "number", "format": "double" }, "audiencePercentage_13_17": { "type": "number", "format": "double" }, "audiencePercentage_18_24": { "type": "number", "format": "double" }, "audiencePercentage_25_34": { "type": "number", "format": "double" }, "audiencePercentage_35_44": { "type": "number", "format": "double" }, "audiencePercentage_45_54": { "type": "number", "format": "double" }, "audiencePercentage_55_64": { "type": "number", "format": "double" }, "audiencePercentage_65_plus": { "type": "number", "format": "double" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "averageComments": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "averageLikes": { "type": "number", "format": "double" }, "bio": { "type": "string" }, "boughtFollowers": { "type": "boolean" }, "contentWarning": { "items": { "$ref": "#/definitions/InstagramContentWarningRequest" }, "type": "array" }, "engagementRate": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "followingCount": { "type": "number", "format": "double" }, "fullName": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "number", "format": "double" }, "isBusiness": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "mediaCount": { "type": "number", "format": "double" }, "nudityLevel": { "type": "string" }, "previewPostsLastUpdatedAt": { "type": "string", "format": "date-time" }, "profanityLevel": { "type": "string" }, "profilePicture": { "type": "string" }, "profileType": { "type": "string", "enum": [ "business", "platform" ], "x-nullable": false }, "lastAnalyzedAt": { "type": "string", "format": "date-time" }, "sponsoredPostRate": { "type": "number", "format": "double" }, "website": { "type": "string" } }, "required": [ "lastAnalyzedAt" ], "type": "object", "additionalProperties": false }, "LaterInfluencerInfo": { "properties": { "adminUrl": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "adminUrl", "id" ], "type": "object" }, "MavelyUser": { "properties": { "mavelyUserId": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double" }, "displayName": { "type": "string", "x-nullable": true }, "username": { "type": "string", "x-nullable": true }, "url": { "type": "string", "x-nullable": true }, "profileImage": { "type": "string", "x-nullable": true }, "bio": { "type": "string", "x-nullable": true } }, "required": [ "mavelyUserId" ], "type": "object", "additionalProperties": false }, "MembershipCostAndPerformance": { "properties": { "activations": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "cpa": { "type": "number", "format": "double" }, "cpe": { "type": "number", "format": "double" }, "cpm": { "type": "number", "format": "double" }, "cpp": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "posts": { "type": "number", "format": "double" }, "rewards": { "type": "number", "format": "double" }, "value": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "DataPointDefinitionActionGroup": { "properties": { "id": { "type": "number", "format": "double" }, "title": { "type": "string" } }, "type": "object", "additionalProperties": false }, "DataPointDefinitionSetElement": { "items": { "properties": { "key": { "type": "string" }, "id": { "type": "number", "format": "double" }, "markUpDisplayLabel": { "type": "string" }, "displayLabel": { "type": "string" } }, "required": [ "key", "id", "displayLabel" ], "type": "object" }, "type": "array" }, "DataPointDefinition": { "properties": { "actionGroups": { "items": { "$ref": "#/definitions/DataPointDefinitionActionGroup" }, "type": "array" }, "archived": { "type": "boolean" }, "communityId": { "type": "string" }, "createdAt": { "type": "string" }, "customSet": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "number", "format": "double" }, "key": { "type": "string" }, "markUpDescription": { "type": "string" }, "mergeTag": { "type": "boolean" }, "multi": { "type": "boolean" }, "name": { "type": "string" }, "setElements": { "$ref": "#/definitions/DataPointDefinitionSetElement" }, "type": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "customSet", "id", "multi", "name", "type" ], "type": "object", "additionalProperties": false }, "PinterestAccount": { "properties": { "averageEngagements": { "type": "number", "format": "double" }, "bio": { "type": "string" }, "boardsCount": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "followingCount": { "type": "number", "format": "double" }, "id": { "type": "object" }, "lastName": { "type": "string" }, "monthlyViewers": { "type": "number", "format": "double" }, "pinsCount": { "type": "number", "format": "double" }, "pinterestAccessGrant": { "properties": { "isExpired": { "type": "boolean" } }, "type": "object" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "username": { "type": "string" } }, "type": "object", "additionalProperties": false }, "NetworkAccount": { "properties": { "averageEngagements": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "username": { "type": "string" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "TikTokAudienceAgeDistribution": { "properties": { "age": { "type": "string", "x-nullable": true }, "percentage": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "age", "percentage" ], "type": "object", "additionalProperties": false }, "TikTokAudienceCountriesDistribution": { "properties": { "country": { "type": "string", "x-nullable": true }, "percentage": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "country", "percentage" ], "type": "object", "additionalProperties": false }, "TikTokAudienceGendersDistribution": { "properties": { "gender": { "type": "string", "x-nullable": true }, "percentage": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "percentage" ], "type": "object", "additionalProperties": false }, "TikTokAudienceInterestDistribution": { "properties": { "interestTag": { "type": "string", "x-nullable": true }, "percentage": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "interestTag", "percentage" ], "type": "object", "additionalProperties": false }, "ActivationContentNetwork": { "type": "string", "enum": [ "blog", "facebook", "facebook_live", "facebook_reel", "facebook_group", "image", "instagram", "instagram_reel", "instagram_story", "linkedin", "musical_ly", "pinterest", "snapchat_story", "tiktok", "twitch_stream", "twitter", "youtube_video", "youtube_shorts", "video" ], "x-nullable": false }, "TikTokVideoViewsBySource": { "properties": { "source": { "type": "string", "x-nullable": true }, "videoViews": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "videoViews" ], "type": "object", "additionalProperties": false }, "ActivationContent": { "properties": { "ytbcLinkState": { "type": "string", "enum": [ "PENDING", "ACTIVE", "DECLINED" ], "x-nullable": false, "description": "CMP-1107: BrandConnect VideoCollaboration consent state for a YouTube video\n(PENDING / ACTIVE / DECLINED). Absent for non-YouTube content or videos whose\nlink state has not been synced. Populated by ActivationService::appendYtbcLinkState." }, "emvValue": { "type": "number", "format": "double", "x-nullable": true }, "followersAtPostDate": { "type": "number", "format": "double" }, "viewsPaid": { "type": "number", "format": "double" }, "viewsOrganic": { "type": "number", "format": "double" }, "views": { "type": "number", "format": "double" }, "videoViewsBySource": { "items": { "$ref": "#/definitions/TikTokVideoViewsBySource" }, "type": "array", "x-nullable": true }, "videoViewTotalTime": { "type": "number", "format": "double" }, "videoCompletionRate": { "type": "number", "format": "double" }, "video": { "type": "string" }, "verifiedImpressions": { "type": "number", "format": "double" }, "updatedAt": { "type": "string", "format": "date-time" }, "text": { "type": "string" }, "sharesPaid": { "type": "number", "format": "double" }, "sharesOrganic": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "reach": { "type": "number", "format": "double" }, "privacy": { "type": "string" }, "postLink": { "type": "string" }, "postDate": { "type": "string" }, "network": { "$ref": "#/definitions/ActivationContentNetwork" }, "manuallyEnteredImpressions": { "type": "number", "format": "double" }, "likesPaid": { "type": "number", "format": "double" }, "likesOrganic": { "type": "number", "format": "double" }, "likes": { "type": "number", "format": "double" }, "influencerReportedImpressions": { "type": "number", "format": "double" }, "impressionsSource": { "type": "string" }, "image": { "type": "string" }, "isDeleted": { "type": "boolean" }, "engagements": { "type": "number", "format": "double" }, "estimatedImpressionsUpdatedAt": { "type": "string", "format": "date-time" }, "estimatedImpressions": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "commentsPaid": { "type": "number", "format": "double", "x-nullable": true }, "commentsOrganic": { "type": "number", "format": "double", "x-nullable": true }, "comments": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "carouselPosts": { "items": { "additionalProperties": true }, "type": "array" }, "canonicalUrlId": { "type": "number", "format": "double" }, "benchmarkEngagementRate": { "type": "number", "format": "double" }, "benchmarkAverageEngagements": { "type": "number", "format": "double" }, "algorithmicImpressions": { "type": "number", "format": "double" }, "activationId": { "type": "number", "format": "double" }, "audienceInterestDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceInterestDistribution" }, "type": "array", "x-nullable": true }, "audienceGendersDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceGendersDistribution" }, "type": "array", "x-nullable": true }, "audienceCountriesDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceCountriesDistribution" }, "type": "array", "x-nullable": true }, "audienceAgeDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceAgeDistribution" }, "type": "array", "x-nullable": true } }, "required": [ "emvValue", "video", "text", "shares", "privacy", "postLink", "network", "likes", "image", "engagements", "estimatedImpressions", "conversions", "conversionValue", "comments", "clicks", "activationId" ], "type": "object" }, "Activation": { "properties": { "actionId": { "type": "string" }, "approvalStatus": { "type": "string" }, "associatedAccount": { "$ref": "#/definitions/NetworkAccount" }, "communityId": { "type": "string" }, "content": { "$ref": "#/definitions/ActivationContent" }, "createdAt": { "type": "string", "format": "date-time" }, "createdByAccountId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "isApproved": { "type": "boolean" }, "membershipId": { "type": "number", "format": "double" }, "selfReported": { "type": "boolean" }, "ugcPhoto": { "type": "string" }, "ugcText": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "updatedByAccountId": { "type": "number", "format": "double" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "required": [ "actionId", "approvalStatus", "communityId", "globalUserId", "id", "isApproved", "membershipId", "ugcPhoto", "ugcText" ], "type": "object", "additionalProperties": false }, "TextSafeSearch": { "properties": { "profanityWordCount": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "VisualSafeSearch": { "properties": { "adult": { "type": "string" }, "medical": { "type": "string" }, "racy": { "type": "string" }, "spoof": { "type": "string" }, "violence": { "type": "string" } }, "type": "object", "additionalProperties": false }, "PreviewPost": { "properties": { "activation": { "$ref": "#/definitions/Activation" }, "caption": { "type": "string" }, "comments": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "imageUrl": { "type": "string" }, "isSponsored": { "type": "boolean" }, "likes": { "type": "number", "format": "double" }, "link": { "type": "string" }, "mentions": { "items": { "type": "string" }, "type": "array" }, "network": { "type": "string" }, "postId": { "type": "string" }, "postedTime": { "type": "string" }, "shares": { "type": "number", "format": "double" }, "source": { "type": "string" }, "textSafeSearch": { "$ref": "#/definitions/TextSafeSearch" }, "views": { "type": "number", "format": "double" }, "visualSafeSearch": { "$ref": "#/definitions/VisualSafeSearch" }, "contentType": { "type": "string" }, "brandMentions": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "TikTokCreator": { "properties": { "displayName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "handleName": { "type": "string" }, "insightsUpdatedAt": { "type": "string" }, "isActive": { "type": "boolean" }, "profileImage": { "type": "string" }, "status": { "type": "string" }, "tiktokAccessGrant": { "additionalProperties": false, "type": "object" }, "engagements": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "likes": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "videoViews": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "TwitterAccount": { "properties": { "averageEngagements": { "type": "number", "format": "double" }, "averageFavorites": { "type": "number", "format": "double" }, "averageRetweets": { "type": "number", "format": "double" }, "description": { "type": "string" }, "engagementRate": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "followingCount": { "type": "number", "format": "double" }, "fullName": { "type": "string" }, "handle": { "type": "string" }, "id": { "type": "object" }, "listedCount": { "type": "number", "format": "double" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "twitterAccessGrant": { "properties": { "isExpired": { "type": "boolean" } }, "type": "object" } }, "type": "object", "additionalProperties": false }, "YoutubeChannelTierStats": { "properties": { "likes": { "type": "number", "format": "double" }, "views": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "engagedViews": { "type": "number", "format": "double" }, "uniqueViewers": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "averageLikesPerVideo": { "type": "number", "format": "double" }, "averageReachPerVideo": { "type": "number", "format": "double" }, "averageViewsPerVideo": { "type": "number", "format": "double" }, "averageCommentsPerVideo": { "type": "number", "format": "double" }, "averageVideosAddedPlaylist": { "type": "number", "format": "double" }, "averageEngagedViewsPerVideo": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "YoutubeChannelStats": { "properties": { "overall": { "$ref": "#/definitions/YoutubeChannelTierStats" }, "video": { "$ref": "#/definitions/YoutubeChannelTierStats" }, "shorts": { "$ref": "#/definitions/YoutubeChannelTierStats" } }, "type": "object", "additionalProperties": false }, "YoutubeChannel": { "properties": { "accountCreatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "bio": { "type": "string" }, "commentCount": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "id": { "type": "object" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "userId": { "type": "number", "format": "double" }, "username": { "type": "string" }, "videoCount": { "type": "number", "format": "double" }, "viewCount": { "type": "number", "format": "double" }, "youtubeExternalId": { "type": "string" }, "handle": { "type": "string" }, "engagementRate": { "type": "number", "format": "double" }, "videoEngagementRate": { "type": "number", "format": "double" }, "shortsEngagementRate": { "type": "number", "format": "double" }, "contentCount": { "type": "number", "format": "double" }, "videoContentCount": { "type": "number", "format": "double" }, "shortsContentCount": { "type": "number", "format": "double" }, "brandMentions": { "items": { "type": "string" }, "type": "array" }, "videoBrandMentions": { "items": { "type": "string" }, "type": "array" }, "shortsBrandMentions": { "items": { "type": "string" }, "type": "array" }, "topics": { "items": { "type": "string" }, "type": "array" }, "stats": { "$ref": "#/definitions/YoutubeChannelStats" }, "refreshedAt": { "type": "string" } }, "type": "object", "additionalProperties": false }, "CreatorProfileFields": { "properties": { "isDiscovered": { "type": "boolean" }, "isPrivate": { "type": "boolean", "x-nullable": true }, "phoneNumber": { "type": "string", "x-nullable": true }, "zipCode": { "type": "string", "x-nullable": true }, "addressLine2": { "type": "string", "x-nullable": true }, "addressLine1": { "type": "string", "x-nullable": true }, "state": { "type": "string", "x-nullable": true }, "city": { "type": "string", "x-nullable": true }, "country": { "type": "string", "x-nullable": true }, "gender": { "type": "object" }, "birthday": { "type": "string", "x-nullable": true }, "fullName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true }, "firstName": { "type": "string", "x-nullable": true }, "email": { "type": "string", "x-nullable": true } }, "required": [ "isDiscovered", "isPrivate", "phoneNumber", "zipCode", "addressLine2", "addressLine1", "state", "city", "country", "gender", "birthday", "fullName", "lastName", "firstName", "email" ], "type": "object", "description": "Identity/profile fields produced by `CreatorRepository.buildProfile` from CDS V2." }, "SnapchatAccount": { "description": "Snapchat account profile data.", "properties": { "bio": { "type": "string", "x-nullable": true }, "followersCount": { "type": "number", "format": "double", "x-nullable": true }, "id": { "type": "string", "x-nullable": true }, "primaryAccount": { "type": "boolean", "x-nullable": true }, "profilePicture": { "type": "string", "x-nullable": true }, "username": { "type": "string", "x-nullable": true }, "snapchatExternalId": { "type": "string", "x-nullable": true }, "handle": { "type": "string", "x-nullable": true }, "averageEngagements": { "type": "number", "format": "double", "x-nullable": true }, "engagementRate": { "type": "number", "format": "double", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "GlobalUserPerformanceMetrics": { "properties": { "emv": { "type": "number", "format": "double" }, "roi": { "type": "number", "format": "double" }, "cpp": { "type": "number", "format": "double" }, "cpe": { "type": "number", "format": "double" }, "cpm": { "type": "number", "format": "double" }, "sponsoredContentEmv": { "type": "number", "format": "double" }, "sponsoredContentRoi": { "type": "number", "format": "double" }, "sponsoredContentCpp": { "type": "number", "format": "double" }, "sponsoredContentCpe": { "type": "number", "format": "double" }, "sponsoredContentCpm": { "type": "number", "format": "double" }, "brandsCount": { "type": "number", "format": "double" }, "campaignsCount": { "type": "number", "format": "double" }, "boundContentCount": { "type": "number", "format": "double" }, "costPerMavelyLinkClick": { "type": "number", "format": "double" }, "mavelyLinksRoi": { "type": "number", "format": "double" }, "mavelyAvgOrderValue": { "type": "number", "format": "double" }, "mavelyLinksSales": { "type": "number", "format": "double" }, "mavelyLinksConversionRate": { "type": "number", "format": "double" }, "hasTrackingOrAffiliateLinksData": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Int64Range": { "properties": { "middle": { "type": "number", "format": "double", "x-nullable": true }, "high": { "type": "number", "format": "double", "x-nullable": true }, "low": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "middle", "high", "low" ], "type": "object" }, "IncentiveRecommendations": { "properties": { "ttPost": { "$ref": "#/definitions/Int64Range" }, "igStory": { "$ref": "#/definitions/Int64Range" }, "igPost": { "$ref": "#/definitions/Int64Range" }, "igReel": { "$ref": "#/definitions/Int64Range" } }, "required": [ "ttPost", "igStory", "igPost", "igReel" ], "type": "object" }, "GlobalUser": { "properties": { "activations": { "type": "number", "format": "double" }, "age": { "type": "object" }, "appMembership": { "$ref": "#/definitions/Membership" }, "apt": { "type": "string" }, "audienceFakeEngagersLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "audienceFakeFollowersLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "audienceFraudLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "audiencePercentageFemale": { "type": "number", "format": "double" }, "audiencePercentage_13_17": { "type": "number", "format": "double" }, "audiencePercentage_18_24": { "type": "number", "format": "double" }, "audiencePercentage_25_34": { "type": "number", "format": "double" }, "audiencePercentage_35_44": { "type": "number", "format": "double" }, "audiencePercentage_45_54": { "type": "number", "format": "double" }, "audiencePercentage_55_64": { "type": "number", "format": "double" }, "audiencePercentage_65_plus": { "type": "number", "format": "double" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "birthday": { "type": "string" }, "blog": { "$ref": "#/definitions/Blog" }, "city": { "type": "string" }, "clicksCount": { "type": "number", "format": "double" }, "conversionCount": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "country": { "type": "string" }, "cpe": { "type": "number", "format": "double" }, "cpm": { "type": "number", "format": "double" }, "cpp": { "type": "number", "format": "double" }, "email": { "type": "string" }, "engagements": { "type": "number", "format": "double" }, "facebookPostsCount": { "type": "number", "format": "double" }, "facebookProfile": { "$ref": "#/definitions/FacebookProfile" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "hasPublicSummaryRecord": { "type": "boolean" }, "id": { "type": "object" }, "influencerTopics": { "items": { "$ref": "#/definitions/Topic" }, "type": "array" }, "instagramAccount": { "$ref": "#/definitions/InstagramAccount" }, "instagramPostsCount": { "type": "number", "format": "double" }, "instagramProfile": { "$ref": "#/definitions/InstagramProfile" }, "isDiscovered": { "type": "boolean" }, "lastName": { "type": "string" }, "lastRefreshedAt": { "type": "string" }, "laterInfluencer": { "$ref": "#/definitions/LaterInfluencerInfo" }, "lists": { "items": { "properties": { "label": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "type": "object" }, "type": "array" }, "mavelyUser": { "$ref": "#/definitions/MavelyUser" }, "membershipCostAndPerformance": { "$ref": "#/definitions/MembershipCostAndPerformance" }, "membershipDataPoints": { "items": { "properties": { "value": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "type": "string" }, "lastEditedBy": { "type": "string" }, "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinition" } }, "type": "object" }, "type": "array" }, "nudityLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "phone": { "type": "string" }, "pinterestAccount": { "$ref": "#/definitions/PinterestAccount" }, "pinterestPostsCount": { "type": "number", "format": "double" }, "previewPosts": { "items": { "$ref": "#/definitions/PreviewPost" }, "type": "array" }, "profanityLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "profilePicture": { "type": "string" }, "registered": { "type": "boolean" }, "rewards": { "type": "number", "format": "double" }, "state": { "type": "string" }, "street": { "type": "string" }, "talentManagerEmail": { "type": "string" }, "tiktokCreator": { "$ref": "#/definitions/TikTokCreator" }, "twitterAccount": { "$ref": "#/definitions/TwitterAccount" }, "twitterPostsCount": { "type": "number", "format": "double" }, "unverified": { "type": "string", "enum": [ "hidden", "emails", "excludes" ], "x-nullable": false }, "userContactInfo": { "properties": { "updatedAt": { "type": "string" }, "referralSlug": { "type": "string" }, "referralCount": { "type": "string" }, "genderDescription": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "emailIsVerified": { "type": "boolean" } }, "type": "object" }, "violenceLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "x-nullable": false }, "youtubeChannel": { "$ref": "#/definitions/YoutubeChannel" }, "deprecated": { "properties": { "mavely": { "$ref": "#/definitions/MavelyUser" }, "youtube": { "$ref": "#/definitions/YoutubeChannel" }, "blog": { "$ref": "#/definitions/Blog" }, "snapchat": { "$ref": "#/definitions/SnapchatAccount" }, "facebook": { "$ref": "#/definitions/FacebookProfile" }, "pinterest": { "$ref": "#/definitions/PinterestAccount" }, "twitter": { "$ref": "#/definitions/TwitterAccount" }, "tiktok": { "$ref": "#/definitions/TikTokCreator" }, "instagram": { "additionalProperties": true }, "creatorInfo": { "$ref": "#/definitions/CreatorProfileFields" } }, "type": "object" }, "zip": { "type": "string" }, "globalPerformanceMetrics": { "$ref": "#/definitions/GlobalUserPerformanceMetrics" }, "snapchatAccount": { "properties": { "engagementRate": { "type": "number", "format": "double", "x-nullable": true }, "averageEngagements": { "type": "number", "format": "double", "x-nullable": true }, "handle": { "type": "string", "x-nullable": true }, "snapchatExternalId": { "type": "string", "x-nullable": true }, "username": { "type": "string", "x-nullable": true }, "profilePicture": { "type": "string", "x-nullable": true }, "primaryAccount": { "type": "boolean", "x-nullable": true }, "id": { "type": "string", "x-nullable": true }, "followersCount": { "type": "number", "format": "double", "x-nullable": true }, "bio": { "type": "string", "x-nullable": true } }, "type": "object" }, "incentiveRecommendations": { "$ref": "#/definitions/IncentiveRecommendations" } }, "type": "object", "additionalProperties": false }, "RetrieveCurrentUserResponse": { "$ref": "#/definitions/GlobalUser" }, "GetGlobalUserResponse": { "$ref": "#/definitions/GlobalUser" }, "ResponseMetadata": { "properties": { "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "failure", "success" ], "x-nullable": false }, "totalCount": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "GetGlobalUsersResponse": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/GlobalUser" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object", "additionalProperties": false }, "GlobalUserUpsertAction": { "enum": [ "created", "existing", "conflict", "error" ], "type": "string" }, "CountryShortName": { "enum": [ "Afghanistan", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "British Virgin Islands", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cambodia", "Cameroon", "Canada", "Cape Verde", "Caribbean Netherlands", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Collectivity of Saint Martin", "Colombia", "Comoros", "Cook Islands", "Costa Rica", "Croatia", "Cuba", "Curaçao", "Cyprus", "Czechia", "Côte d'Ivoire", "Democratic Republic of the Congo", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Malvinas)", "Faroe Islands", "Federated States of Micronesia", "Fiji", "Finland", "France", "French Guiana", "French Polynesia", "French Southern Territories", "Gabon", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City)", "Honduras", "Hong Kong", "Hungary", "Iceland", "India", "Indonesia", "Iran", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macau", "Macedonia (FYROM)", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar (Burma)", "Namibia", "Nauru", "Nepal", "Netherlands", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "North Korea", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestine", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn", "Poland", "Portugal", "Puerto Rico", "Qatar", "Republic of Indonesia", "Republic of the Congo", "Reunion", "Romania", "Russia", "Rwanda", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Saint-Barthélemy", "Samoa", "San Marino", "Sao Tome and Principe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten (Dutch part)", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Korea", "South Sudan", "Spain", "Sri Lanka", "Sudan", "Suriname", "Svalbard and Jan Mayen", "Swaziland", "Sweden", "Switzerland", "Syria", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "The Bahamas", "The Gambia", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Virgin Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "United States Minor Outlying Islands", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe", "Åland Islands" ], "type": "string" }, "GlobalUserFields": { "properties": { "phone": { "type": "string" }, "zip": { "type": "string" }, "mavelyHandle": { "type": "string" }, "blogHandle": { "type": "string" }, "snapchatHandle": { "type": "string" }, "facebookHandle": { "type": "string" }, "youtubeHandle": { "type": "string" }, "twitterHandle": { "type": "string" }, "tiktokHandle": { "type": "string" }, "talentManagerEmail": { "type": "string" }, "state": { "type": "string" }, "pinterestHandle": { "type": "string" }, "loadSource": { "type": "string" }, "lastName": { "type": "string" }, "isCreateNewMyMember": { "type": "boolean" }, "addToInfluencerIndex": { "type": "boolean" }, "instagramHandle": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "facebookUrl": { "type": "string" }, "email": { "type": "string" }, "deletedCreatedAt": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "country": { "$ref": "#/definitions/CountryShortName" }, "city": { "type": "string" }, "blogUrl": { "type": "string" }, "birthday": { "type": "string", "format": "date-time" }, "apt": { "type": "string" }, "street": { "type": "string" } }, "type": "object" }, "SocialPresenceInput": { "properties": { "platform": { "type": "string" }, "username": { "type": "string" } }, "required": [ "platform", "username" ], "type": "object", "additionalProperties": false }, "UpdateGlobalUserBodyDefinition": { "properties": { "socialPresences": { "items": { "$ref": "#/definitions/SocialPresenceInput" }, "type": "array" }, "data": { "$ref": "#/definitions/GlobalUserFields" } }, "required": [ "data" ], "type": "object" }, "TSOAEmptyObject": { "properties": {}, "type": "object", "additionalProperties": false }, "RefreshAudienceDemographicsBody": { "properties": { "platforms": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "GlobalUserAudienceGraphDatapoint": { "properties": { "value": { "type": "number", "format": "double" }, "display": { "type": "string" } }, "required": [ "value", "display" ], "type": "object" }, "GlobalUserAudienceDemographicsGraph": { "properties": { "data": { "items": { "$ref": "#/definitions/GlobalUserAudienceGraphDatapoint" }, "type": "array" }, "id": { "type": "string" } }, "required": [ "data", "id" ], "type": "object" }, "DynamoGlobalUserAudienceDemographicsPayload": { "properties": { "audienceAge21Plus": { "type": "number", "format": "double" }, "dataUpdatedAt": { "type": "string", "x-nullable": true }, "graphs": { "items": { "$ref": "#/definitions/GlobalUserAudienceDemographicsGraph" }, "type": "array" }, "followersCount": { "type": "number", "format": "double" }, "handle": { "type": "string" }, "updatedAt": { "type": "string" }, "requestIdCreatedAt": { "type": "string", "x-nullable": true }, "requestId": { "type": "number", "format": "double", "x-nullable": true }, "requestErrorDetails": { "type": "string" }, "requestStatus": { "type": "string" } }, "type": "object", "description": "**********\nDynamoDB *\n**********" }, "DynamoGlobalUserAudienceDemographics": { "properties": { "audienceDemographics": { "properties": { "snapchat": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "facebook": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "youtubeShorts": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "youtubeVideos": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "youtube": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "tiktok": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" }, "instagram": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographicsPayload" } }, "type": "object" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "globalUserId" ], "type": "object" }, "GlobalUserAudienceDemographicsResponse": { "$ref": "#/definitions/DynamoGlobalUserAudienceDemographics", "description": "***************\nResponse Body *\n**************" }, "BrandSafetyRequestReponse": { "properties": { "audienceAuthenticity": { "properties": { "message": { "type": "string" }, "status": { "type": "string" } }, "required": [ "message", "status" ], "type": "object" }, "contentWarning": { "items": { "properties": { "postId": { "type": "string" }, "status": { "type": "string" } }, "required": [ "postId", "status" ], "type": "object" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "AssessmentMetadataDTO": { "properties": { "creatorContext": { "type": "string" }, "brandContext": { "type": "string", "x-nullable": true }, "campaignContext": { "type": "string", "x-nullable": true } }, "required": [ "creatorContext", "brandContext", "campaignContext" ], "type": "object", "additionalProperties": false }, "DataScoreLevelDTO": { "description": "Brand Suitability LLM/assessment output DTOs.\n`v0.3 UI:` notes track field consumption by the v0.3 report view. \"unused\" = not read by v0.3 (may be used by legacy/admin). Audited 2026-06-22.", "enum": [ "HIGH", "MEDIUM", "LOW", "NONE" ], "type": "string" }, "DataConfidenceDTO": { "properties": { "confidence": { "$ref": "#/definitions/DataScoreLevelDTO" }, "score": { "type": "number", "format": "double" }, "reason": { "type": "string" } }, "required": [ "confidence", "score", "reason" ], "type": "object", "additionalProperties": false }, "ExecutiveSummaryDTO": { "properties": { "overallAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "assessment": { "type": "string" } }, "required": [ "dataConfidence", "assessment" ], "type": "object" }, "overallRiskAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallBrandRelevancyAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallRiskLevel": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallRecommendation": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" } }, "required": [ "overallAssessment", "overallRiskAssessment", "overallBrandRelevancyAssessment", "overallRiskLevel", "overallRecommendation" ], "type": "object", "additionalProperties": false }, "DataSourceDTO": { "properties": { "attribute": { "type": "string", "enum": [ "risk", "brandRelevance" ], "x-nullable": false }, "url": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "attribute", "url", "reason" ], "type": "object", "additionalProperties": false }, "AttributeDTO": { "properties": { "type": { "type": "string", "enum": [ "risk", "brandRelevance" ], "x-nullable": false }, "score": { "type": "number", "format": "double" }, "findings": { "type": "string" }, "sources": { "items": { "$ref": "#/definitions/DataSourceDTO" }, "type": "array" } }, "required": [ "type", "score", "sources" ], "type": "object", "additionalProperties": false }, "AssessmentMetricDTO": { "properties": { "metric": { "type": "string" }, "metricName": { "type": "string" }, "attributes": { "items": { "$ref": "#/definitions/AttributeDTO" }, "type": "array" }, "summary": { "type": "string" }, "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" } }, "required": [ "metric", "metricName", "attributes", "summary", "dataConfidence" ], "type": "object", "additionalProperties": false }, "DiscoveriesDTO": { "properties": { "majorRedFlags": { "items": { "properties": { "source": { "type": "string" }, "flag": { "type": "string" } }, "required": [ "source", "flag" ], "type": "object" }, "type": "array" }, "recentControversies": { "items": { "properties": { "source": { "type": "string" }, "controversy": { "type": "string" } }, "required": [ "source", "controversy" ], "type": "object" }, "type": "array" }, "partnershipHistory": { "items": { "properties": { "source": { "type": "string" }, "brand": { "type": "string" } }, "required": [ "source", "brand" ], "type": "object" }, "type": "array" }, "positiveIndicators": { "items": { "properties": { "source": { "type": "string" }, "indicator": { "type": "string" } }, "required": [ "source", "indicator" ], "type": "object" }, "type": "array" } }, "required": [ "majorRedFlags", "recentControversies", "partnershipHistory", "positiveIndicators" ], "type": "object", "additionalProperties": false }, "DataSourcesDTO": { "properties": { "articlesAnalyzed": { "type": "number", "format": "double" }, "platformsSearched": { "items": { "type": "string" }, "type": "array" }, "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "dataGaps": { "items": { "type": "string" }, "type": "array" }, "allSources": { "items": { "type": "string" }, "type": "array" }, "findingsVersion": { "type": "string" } }, "required": [ "articlesAnalyzed", "platformsSearched", "dataConfidence", "dataGaps", "allSources" ], "type": "object", "additionalProperties": false }, "BrandAlignmentSignalDTO": { "properties": { "severity": { "type": "number", "format": "double" }, "relevance": { "type": "number", "format": "double" }, "reason": { "type": "string" }, "source": { "type": "string" } }, "required": [ "severity", "relevance", "reason", "source" ], "type": "object", "additionalProperties": false }, "CreatorAuthenticityDTO": { "properties": { "level": { "type": "string", "enum": [ "HIGH", "MEDIUM", "LOW" ], "x-nullable": false }, "score": { "type": "number", "format": "double" }, "summary": { "type": "string" }, "findings": { "type": "string" }, "signals": { "items": { "$ref": "#/definitions/BrandAlignmentSignalDTO" }, "type": "array" } }, "required": [ "level", "score", "summary", "findings", "signals" ], "type": "object", "additionalProperties": false }, "BrandAlignmentDTO": { "properties": { "creatorAuthenticity": { "$ref": "#/definitions/CreatorAuthenticityDTO" } }, "required": [ "creatorAuthenticity" ], "type": "object", "additionalProperties": false }, "Partial_BrandSuitabilityAssessmentDTO_": { "properties": { "assessmentMetadata": { "$ref": "#/definitions/AssessmentMetadataDTO" }, "executiveSummary": { "$ref": "#/definitions/ExecutiveSummaryDTO" }, "assessment": { "items": { "$ref": "#/definitions/AssessmentMetricDTO" }, "type": "array" }, "discoveries": { "$ref": "#/definitions/DiscoveriesDTO" }, "dataSources": { "$ref": "#/definitions/DataSourcesDTO" }, "brandAlignment": { "$ref": "#/definitions/BrandAlignmentDTO" } }, "type": "object", "description": "Make all properties in T optional" }, "ExecutiveSummary": { "type": "object", "properties": { "overallAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "assessment": { "type": "string" } }, "required": [ "dataConfidence", "assessment" ], "type": "object" }, "overallRiskAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallBrandRelevancyAssessment": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallRiskLevel": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" }, "overallRecommendation": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "reason": { "type": "string" }, "level": { "$ref": "#/definitions/DataScoreLevelDTO" } }, "required": [ "dataConfidence", "reason", "level" ], "type": "object" } } }, "AssessmentMetadata": { "type": "object", "properties": { "creatorContext": { "type": "string" }, "brandContext": { "type": "string", "x-nullable": true }, "campaignContext": { "type": "string", "x-nullable": true } } }, "Assessments": { "items": { "type": "object", "properties": { "metric": { "type": "string" }, "metricName": { "type": "string" }, "attributes": { "items": { "$ref": "#/definitions/AttributeDTO" }, "type": "array" }, "summary": { "type": "string" }, "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" } } }, "type": "array" }, "Discoveries": { "$ref": "#/definitions/DiscoveriesDTO" }, "ExtractedAttributes": { "properties": { "names": { "items": { "type": "string" }, "type": "array" }, "handles": { "items": { "type": "string" }, "type": "array" }, "urls": { "items": { "type": "string" }, "type": "array" }, "profession": { "type": "string", "x-nullable": true }, "location": { "type": "string", "x-nullable": true }, "topics": { "items": { "type": "string" }, "type": "array" } }, "required": [ "names", "handles", "urls", "profession", "location", "topics" ], "type": "object", "additionalProperties": false }, "StoredFinding": { "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "detailedSummary": { "type": "string" }, "keyQuotes": { "items": { "type": "string" }, "type": "array" }, "sourceDate": { "type": "string", "x-nullable": true }, "dateFound": { "type": "string" }, "sentiment": { "type": "string", "enum": [ "negative", "neutral", "positive", "" ], "x-nullable": false }, "credibility": { "type": "string", "enum": [ "high", "medium", "low" ], "x-nullable": false }, "relevance": { "type": "number", "enum": [ 0, 1, 2 ], "x-nullable": false }, "extractedAttributes": { "$ref": "#/definitions/ExtractedAttributes" }, "excluded": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "DataSources": { "$ref": "#/definitions/DataSourcesDTO" }, "BrandSuitabilityReportStatus": { "enum": [ "COMPLETED", "PROCESSING", "FAILED", "NOT_FOUND" ], "type": "string" }, "BrandSuitabilityReportProgress": { "enum": [ "PENDING", "RESEARCHING", "ASSESSING" ], "type": "string" }, "BatchMetricRisk": { "properties": { "summary": { "type": "string" }, "score": { "type": "number", "format": "double" }, "riskScore": { "type": "number", "format": "double" }, "metricName": { "type": "string" }, "metric": { "type": "string" } }, "required": [ "summary", "riskScore", "metricName", "metric" ], "type": "object" }, "RequesterMetadata": { "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "object" } }, "type": "object" }, "BrandSuitabilityReport": { "type": "object", "properties": {} }, "GetBrandSuitabilityReportResponse": { "properties": { "data": { "$ref": "#/definitions/BrandSuitabilityReport" }, "status": { "$ref": "#/definitions/BrandSuitabilityReportStatus" } }, "required": [ "status" ], "type": "object", "additionalProperties": false }, "GenerateBrandSuitabilityReportResponse": { "properties": { "reportId": { "type": "string" }, "status": { "$ref": "#/definitions/BrandSuitabilityReportStatus" }, "data": { "$ref": "#/definitions/BrandSuitabilityReport" }, "message": { "type": "string" } }, "required": [ "reportId", "status" ], "type": "object", "additionalProperties": false }, "GenerateBrandSuitabilityReportRequest": { "properties": { "campaignId": { "type": "number", "format": "double" }, "brandName": { "type": "string" }, "assessments": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "GlobalUserSocialProfile": { "properties": { "username": { "type": "string", "x-nullable": true }, "url": { "type": "string", "x-nullable": true }, "type": { "type": "string", "enum": [ "facebook_user", "facebook_page" ], "x-nullable": false }, "socialPresenceData": { "additionalProperties": false, "type": "object" }, "profileImage": { "type": "string", "x-nullable": true }, "platformId": { "type": "string", "x-nullable": true }, "platform": { "type": "string" }, "isPrivate": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "isDiscovered": { "type": "boolean" }, "globalUserId": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "displayName": { "type": "string", "x-nullable": true }, "bio": { "type": "string", "x-nullable": true } }, "required": [ "username", "platform", "isPrimary", "isDiscovered", "globalUserId", "followersCount" ], "type": "object" }, "GlobalUserProfile": { "properties": { "socialProfiles": { "items": { "$ref": "#/definitions/GlobalUserSocialProfile" }, "type": "array" }, "zipCode": { "type": "string" }, "state": { "type": "string" }, "phoneNumber": { "type": "string" }, "lastName": { "type": "string" }, "isContactable": { "type": "boolean" }, "globalUserId": { "type": "number", "format": "double" }, "gender": { "type": "string" }, "firstName": { "type": "string" }, "ethnicities": { "items": { "type": "string" }, "type": "array" }, "email": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "birthday": { "type": "string" }, "address": { "type": "string" } }, "required": [ "socialProfiles", "globalUserId" ], "type": "object" }, "GlobalUserSearchAllSocialProfilesByIdsPostResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/GlobalUserProfile" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "GlobalUserSearchAllSocialProfilesByIdsPostParams": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "globalUserIds" ], "type": "object" }, "GlobalUserInconsistency": { "properties": { "affectedEntities": { "items": { "type": "string" }, "type": "array" }, "message": { "type": "string" }, "type": { "type": "string" } }, "required": [ "affectedEntities", "message", "type" ], "type": "object" }, "GlobalUserInconsistencies": { "properties": { "inconsistencies": { "items": { "$ref": "#/definitions/GlobalUserInconsistency" }, "type": "array" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "inconsistencies", "globalUserId" ], "type": "object" }, "GlobalUserGetInconsistenciesPostResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/GlobalUserInconsistencies" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "GlobalUserGetInconsistenciesPostParams": { "properties": { "plugins": { "items": { "type": "string" }, "type": "array", "description": "If no plugins are provided, all plugins will be used" }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array", "minItems": 1 } }, "required": [ "globalUserIds" ], "type": "object" }, "GlobalUserFix": { "properties": { "status": { "type": "string", "enum": [ "fixed", "skipped", "failed" ], "x-nullable": false }, "affectedEntities": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "status", "affectedEntities", "type" ], "type": "object" }, "GlobalUserFixes": { "properties": { "fixes": { "items": { "$ref": "#/definitions/GlobalUserFix" }, "type": "array" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "fixes", "globalUserId" ], "type": "object" }, "GlobalUserRepairPostResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/GlobalUserFixes" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "GlobalUserRepairPostParams": { "properties": { "plugins": { "items": { "type": "string" }, "type": "array", "description": "If no plugins are provided, all plugins will be used" }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array", "minItems": 1 } }, "required": [ "globalUserIds" ], "type": "object" }, "GlobalUserGetRandomGlobalUsersResponse": { "properties": { "data": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "AudienceCountry": { "properties": { "country": { "type": "string" }, "percentage": { "type": "number", "format": "double" } }, "required": [ "country", "percentage" ], "type": "object", "additionalProperties": false }, "GlobalUserAudienceCountriesQueryResult": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/AudienceCountry" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object", "additionalProperties": false }, "ImportInfluencerCsvRow": { "properties": { "Mavely Handle": { "type": "string" }, "Blog Handle": { "type": "string" }, "Snapchat Handle": { "type": "string" }, "YouTube Handle": { "type": "string" }, "Twitter Handle": { "type": "string" }, "Pinterest Handle": { "type": "string" }, "Facebook Handle": { "type": "string" }, "TikTok Handle": { "type": "string" }, "Instagram Handle": { "type": "string" }, "Email": { "type": "string" }, "Last Name": { "type": "string" }, "First Name": { "type": "string" } }, "required": [ "First Name" ], "type": "object" }, "ImportInfluencerBody": { "properties": { "csvData": { "items": { "$ref": "#/definitions/ImportInfluencerCsvRow" }, "type": "array" }, "addToInfluencerIndex": { "type": "boolean" }, "addToMyMembers": { "type": "boolean" } }, "required": [ "csvData", "addToInfluencerIndex", "addToMyMembers" ], "type": "object" }, "ContentPost": { "properties": { "id": { "type": "string" }, "createdAt": { "type": "string", "x-nullable": true }, "updatedAt": { "type": "string", "x-nullable": true }, "deletedAt": { "type": "string", "x-nullable": true }, "publishedAt": { "type": "string", "x-nullable": true }, "socialPresenceId": { "type": "string" }, "platform": { "type": "string" }, "platformId": { "type": "string" }, "permalink": { "type": "string" }, "context": { "type": "string" }, "mediaFormat": { "type": "string" }, "caption": { "type": "string" }, "mediaThumbnail": { "type": "string" }, "sponsor": { "type": "string" }, "taggedBrands": { "items": { "type": "string" }, "type": "array" }, "clicksCount": { "type": "number", "format": "double" }, "commentsCount": { "type": "number", "format": "double" }, "viewsCount": { "type": "number", "format": "double" }, "reachCount": { "type": "number", "format": "double" }, "reactionsCount": { "type": "number", "format": "double" }, "sharesCount": { "type": "number", "format": "double" }, "reachFollowersRate": { "type": "number", "format": "double" }, "reachNonFollowersRate": { "type": "number", "format": "double" }, "viewsFollowersRate": { "type": "number", "format": "double" }, "viewsNonFollowersRate": { "type": "number", "format": "double" } }, "required": [ "id", "createdAt", "updatedAt", "deletedAt", "publishedAt", "socialPresenceId", "platform", "platformId", "permalink", "context", "mediaFormat", "caption", "mediaThumbnail", "sponsor", "taggedBrands", "clicksCount", "commentsCount", "viewsCount", "reachCount", "reactionsCount", "sharesCount", "reachFollowersRate", "reachNonFollowersRate", "viewsFollowersRate", "viewsNonFollowersRate" ], "type": "object", "additionalProperties": false }, "BulkActionsBody": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "action": { "type": "string", "enum": [ "reindex", "refreshAudienceDemographics" ], "x-nullable": false }, "options": { "properties": { "concurrency": { "type": "number", "format": "double" }, "platforms": { "items": { "type": "string", "enum": [ "instagram", "tiktok" ], "x-nullable": false }, "type": "array" } }, "type": "object" } }, "required": [ "globalUserIds", "action" ], "type": "object", "additionalProperties": false }, "CurrentAdministratorAccount": { "properties": { "administratorId": { "type": "number", "format": "double", "x-nullable": true }, "token": { "type": "string" }, "status": { "type": "string", "enum": [ "APPROVED", "PENDING", "DELETED", "SUSPENDED" ], "x-nullable": false }, "root": { "type": "boolean" }, "roleId": { "type": "number", "format": "double" }, "last_name": { "type": "string", "x-nullable": true }, "image": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "first_name": { "type": "string", "x-nullable": true }, "email": { "type": "string" }, "configurePaymentProvider": { "type": "boolean" }, "community_id": { "type": "string" } }, "required": [ "administratorId", "token", "status", "root", "roleId", "last_name", "image", "id", "first_name", "email", "configurePaymentProvider", "community_id" ], "type": "object" }, "AdministratorAccountPutBody": { "properties": { "newPassword": { "type": "string" }, "lastName": { "type": "string" }, "image": { "type": "string" }, "firstName": { "type": "string" }, "existingPassword": { "type": "string" } }, "type": "object" }, "AdministratorAccountPostBody": { "properties": { "roleId": { "type": "number", "format": "double" }, "password": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "email": { "type": "string" } }, "required": [ "password", "email" ], "type": "object" }, "GlobalUserSocialAccounts": { "properties": { "facebookProfiles": { "items": { "$ref": "#/definitions/FacebookProfile" }, "type": "array" }, "instagramAccounts": { "items": { "$ref": "#/definitions/InstagramAccount" }, "type": "array" }, "pinterestAccounts": { "items": { "$ref": "#/definitions/PinterestAccount" }, "type": "array" }, "twitterAccounts": { "items": { "$ref": "#/definitions/TwitterAccount" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "GlobalUserSocialAccountsResponse": { "$ref": "#/definitions/GlobalUserSocialAccounts" }, "Pick_ActivationTag.name_": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "ActivationTagPostResponse": { "$ref": "#/definitions/Pick_ActivationTag.name_" }, "ActivationTagPostRequestBody": { "$ref": "#/definitions/Pick_ActivationTag.name_" }, "ActivationTag": { "properties": { "communityId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "number", "format": "double" }, "name": { "type": "string" } }, "required": [ "communityId", "createdAt", "id", "name" ], "type": "object", "additionalProperties": false }, "ResponseMeta": { "properties": { "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "ActivationTagsGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActivationTag" }, "type": "array" }, "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" } }, "required": [ "totalCount", "offset", "limit" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "ExportType": { "enum": [ "ACTIONGROUPINFLUENCERS", "MEMBERINFLUENCERS", "PROGRAMPERFORMANCECAMPAIGN" ], "type": "string" }, "ExportBody": { "properties": { "type": { "$ref": "#/definitions/ExportType" }, "actionGroupId": { "type": "number", "format": "double" }, "userFilter": { "additionalProperties": true }, "communityId": { "type": "string" }, "customStatusSlug": { "type": "string" }, "filter": { "additionalProperties": true }, "q": { "type": "string" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "ContentExportBody": { "properties": { "actionGroupId": { "type": "object" }, "limit": { "type": "number", "format": "double" }, "networks": { "items": { "type": "string" }, "type": "array" }, "offset": { "type": "number", "format": "double" }, "orderDirection": { "type": "string" }, "orderProperty": { "type": "string" }, "postDateAfter": { "type": "string" }, "postDateBefore": { "type": "string" }, "postsWithUGC": { "type": "boolean" }, "queryFilter": { "additionalProperties": true }, "userFilter": { "type": "string" }, "filterTagIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "tagQuantifier": { "type": "string", "enum": [ "any", "all" ], "x-nullable": false }, "exportCsvOnly": { "type": "boolean" }, "urgent": { "type": "boolean" } }, "required": [ "actionGroupId", "limit", "networks", "offset", "orderDirection", "orderProperty", "postsWithUGC" ], "type": "object", "additionalProperties": false }, "Age": { "properties": { "age": { "type": "string" }, "percent": { "type": "number", "format": "double" } }, "required": [ "age", "percent" ], "type": "object", "additionalProperties": false }, "City": { "properties": { "city": { "type": "string" }, "cityState": { "type": "string" }, "impressions": { "type": "number", "format": "double" } }, "required": [ "city", "cityState", "impressions" ], "type": "object", "additionalProperties": false }, "Country": { "properties": { "country": { "type": "string" }, "impressions": { "type": "number", "format": "double" } }, "required": [ "country", "impressions" ], "type": "object", "additionalProperties": false }, "GenderImpressions": { "properties": { "femaleImpressions": { "type": "number", "format": "double" }, "maleImpressions": { "type": "number", "format": "double" }, "totalImpressions": { "type": "number", "format": "double" } }, "required": [ "femaleImpressions", "maleImpressions", "totalImpressions" ], "type": "object", "additionalProperties": false }, "CampaignAudienceInsights": { "properties": { "age": { "items": { "$ref": "#/definitions/Age" }, "type": "array" }, "cities": { "items": { "$ref": "#/definitions/City" }, "type": "array" }, "countries": { "items": { "$ref": "#/definitions/Country" }, "type": "array" }, "gender": { "$ref": "#/definitions/GenderImpressions" }, "totalAudienceImpressions": { "type": "number", "format": "double" } }, "required": [ "age", "cities", "countries", "gender", "totalAudienceImpressions" ], "type": "object", "additionalProperties": false }, "Pick_AdministratorAccount.email-or-first_name-or-image-or-last_name_": { "properties": { "image": { "type": "string", "x-nullable": true }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "required": [ "email" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "DraftContentFeedbackEntry": { "properties": { "id": { "type": "number", "format": "double" }, "draftContentId": { "type": "number", "format": "double" }, "accountId": { "type": "number", "format": "double", "x-nullable": true }, "administratorAccount": { "$ref": "#/definitions/Pick_AdministratorAccount.email-or-first_name-or-image-or-last_name_" }, "text": { "type": "string" }, "commenterType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" } }, "required": [ "id", "draftContentId", "accountId", "text", "commenterType", "createdAt", "isArchived" ], "type": "object", "additionalProperties": false }, "NetworkSlug": { "type": "string", "enum": [ "blog", "facebook", "facebook_group", "facebook_live", "facebook_reel", "image", "instagram", "instagram_reel", "instagram_story", "linkedin", "pinterest", "snapchat_story", "tiktok", "twitch_stream", "twitter", "video", "youtube_video", "youtube_shorts" ], "x-nullable": false }, "InfluencerDraftContentFile": { "properties": { "codec": { "type": "string" }, "draftContentId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "originalUrl": { "type": "string" }, "size": { "type": "number", "format": "double" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "draftContentId", "id", "name", "type", "url" ], "type": "object", "additionalProperties": false }, "InfluencerDraftContentComment": { "properties": { "accountId": { "type": "number", "format": "double" }, "administratorAccount": { "$ref": "#/definitions/Pick_AdministratorAccount.email-or-first_name-or-image-or-last_name_" }, "archivedByAccountId": { "type": "number", "format": "double" }, "commenterName": { "type": "string" }, "commenterType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "draftContentId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "isArchived": { "type": "boolean" }, "text": { "type": "string" } }, "required": [ "commenterType", "createdAt", "draftContentId", "id", "isArchived", "text" ], "type": "object", "additionalProperties": false }, "Pick_DraftContentViewed.draftContentId-or-email-or-viewedAt_": { "properties": { "email": { "type": "string" }, "draftContentId": { "type": "number", "format": "double" }, "viewedAt": { "type": "string", "format": "date-time" } }, "required": [ "email", "draftContentId", "viewedAt" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Pick_InfluencerDraftContent.Exclude_keyofInfluencerDraftContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId__": { "properties": { "id": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "text": { "type": "string" }, "status": { "type": "string", "description": "`status` should be 'approved', 'conditionally_approved', 'pending', 'rejected', or 'rejected_no_notification'." }, "notes": { "type": "string" }, "feedback": { "type": "string" }, "feedbackList": { "items": { "$ref": "#/definitions/DraftContentFeedbackEntry" }, "type": "array" }, "contentUrl": { "type": "string" }, "contentType": { "$ref": "#/definitions/NetworkSlug" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" }, "archivedByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "archivedByGlobalUserId": { "type": "number", "format": "double", "x-nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "files": { "items": { "$ref": "#/definitions/InfluencerDraftContentFile" }, "type": "array" }, "comments": { "items": { "$ref": "#/definitions/InfluencerDraftContentComment" }, "type": "array" }, "threadId": { "type": "string" }, "viewed": { "$ref": "#/definitions/Pick_DraftContentViewed.draftContentId-or-email-or-viewedAt_" } }, "required": [ "id", "listMemberId", "status", "feedbackList", "contentType", "createdAt", "updatedAt", "isArchived", "archivedByAccountId", "archivedByGlobalUserId", "archivedAt", "files", "comments", "threadId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_InfluencerDraftContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId_": { "$ref": "#/definitions/Pick_InfluencerDraftContent.Exclude_keyofInfluencerDraftContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId__", "description": "Construct a type with the properties of T except for those in type K." }, "UploaderInfo": { "properties": { "type": { "type": "string", "x-nullable": true }, "email": { "type": "string", "x-nullable": true } }, "required": [ "type", "email" ], "type": "object", "additionalProperties": false }, "InfluencerDraftContentDto": { "type": "object", "properties": {} }, "InfluencerDraftContentPostFile": { "properties": { "originalFile": { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "isUploaded": { "type": "boolean" }, "lastModified": { "type": "number", "format": "double" }, "url": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "number", "format": "double" }, "name": { "type": "string" }, "code": { "type": "string" } }, "type": "object" }, "AdminDraftContentPostBody": { "properties": { "contentType": { "$ref": "#/definitions/NetworkSlug" }, "contentUrl": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/InfluencerDraftContentPostFile" }, "type": "array" }, "notes": { "type": "string" }, "text": { "type": "string" }, "threadId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" }, "internalComment": { "type": "string" } }, "required": [ "contentType", "globalUserId", "campaignId" ], "type": "object", "additionalProperties": false }, "DraftContentUpdateBody": { "properties": { "notes": { "type": "string" }, "text": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/InfluencerDraftContentPostFile" }, "type": "array" }, "isArchived": { "type": "boolean" }, "feedback": { "type": "string" }, "draftContentId": { "type": "number", "format": "double" } }, "required": [ "draftContentId" ], "type": "object" }, "DraftContentStatusUpdateBody": { "properties": { "draftContentId": { "type": "number", "format": "double" }, "data": { "properties": { "status": { "type": "string", "enum": [ "rejected", "rejected_no_notification", "conditionally_approved", "approved" ], "x-nullable": false } }, "required": [ "status" ], "type": "object" } }, "required": [ "draftContentId", "data" ], "type": "object", "additionalProperties": false }, "draftContentFeedbackUpdateBody": { "properties": { "feedback": { "type": "string" } }, "required": [ "feedback" ], "type": "object" }, "InfluencerPollingRequestBody": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" } }, "required": [ "actionGroupId" ], "type": "object" }, "Question": { "properties": { "className": { "type": "string" }, "dataPointDefinition": { "$ref": "#/definitions/DataPointDefinition" }, "dataPointDefinitionId": { "type": "number", "format": "double" }, "hasResponses": { "type": "boolean" }, "hideFromInfluencers": { "type": "boolean" }, "id": { "type": "number", "format": "double" }, "key": { "type": "string" }, "maxResponses": { "type": "number", "format": "double" }, "order": { "type": "number", "format": "double" }, "questionResponses": { "items": { "additionalProperties": false, "type": "object" }, "type": "array" }, "questionText": { "type": "string" }, "markUpQuestionText": { "type": "string" }, "properties": { "properties": { "type": { "type": "string" }, "required": { "type": "boolean" }, "placeholder": { "type": "string" }, "options": { "items": { "properties": { "value": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "minlength": { "type": "number", "format": "double" }, "min": { "type": "number", "format": "double" }, "maxlength": { "type": "number", "format": "double" }, "maxUploads": { "type": "number", "format": "double" }, "max": { "type": "number", "format": "double" }, "label": { "type": "string" }, "accept": { "type": "string" } }, "type": "object" }, "required": { "type": "boolean" }, "templateOptions": { "additionalProperties": false, "type": "object" }, "type": { "type": "string" } }, "type": "object", "additionalProperties": false }, "QuestionResponse": { "properties": { "question": { "$ref": "#/definitions/Question" }, "value": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Action": { "properties": { "ActionGroup": { "$ref": "#/definitions/ActionGroup" }, "actionGroupId": { "type": "number", "format": "double" }, "actionGroupTitle": { "type": "string" }, "actionGroupType": { "type": "string" }, "activations": { "items": { "properties": { "id": { "type": "number", "format": "double" } }, "type": "object" }, "type": "array" }, "article": { "properties": { "html": { "type": "string" } }, "type": "object" }, "brand": { "$ref": "#/definitions/Brand" }, "communityId": { "type": "string" }, "conversion": { "$ref": "#/definitions/ConversionTag" }, "conversionAssignedAt": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "image": { "type": "string" }, "instructions": { "type": "string" }, "label": { "type": "string" }, "link": { "$ref": "#/definitions/TrackingLink" }, "linkReference": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "multipleActivations": { "type": "boolean" }, "needsModeration": { "type": "boolean" }, "networkOperation": { "$ref": "#/definitions/NetworkOperation" }, "pendingActivation": { "items": { "properties": { "id": { "type": "number", "format": "double" } }, "type": "object" }, "type": "array" }, "points": { "type": "number", "format": "double" }, "previewContentType": { "type": "string" }, "product": { "$ref": "#/definitions/Product" }, "productId": { "type": "number", "format": "double" }, "required": { "type": "boolean" }, "reviewFormId": { "type": "number", "format": "double" }, "routing": { "$ref": "#/definitions/Routing" }, "submit": { "type": "string" }, "survey": { "$ref": "#/definitions/ReviewForm" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "video": { "properties": { "url": { "type": "string" } }, "type": "object" } }, "required": [ "type" ], "type": "object", "additionalProperties": false }, "InfluencerDataPointCriteria": { "properties": { "key": { "type": "string" }, "value": { "type": "object" }, "values": { "items": { "type": "string" }, "type": "array" }, "minValue": { "type": "number", "format": "double" }, "maxValue": { "type": "number", "format": "double" } }, "required": [ "key" ], "type": "object", "additionalProperties": false }, "Audience": { "properties": { "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "criteria": { "items": { "$ref": "#/definitions/InfluencerDataPointCriteria" }, "type": "array" } }, "required": [ "id", "name", "criteria" ], "type": "object", "additionalProperties": false }, "Brand": { "properties": { "accentColor": { "type": "string" }, "buttonColor": { "type": "string" }, "id": { "type": "number", "format": "double" }, "logo": { "type": "string" }, "associatedWithCampaign": { "type": "boolean" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object", "additionalProperties": false }, "ActionGroup": { "properties": { "actions": { "items": { "$ref": "#/definitions/Action" }, "type": "array" }, "activatedUsersMetrics": { "type": "number", "format": "double" }, "activityBudget": { "type": "number", "format": "double" }, "application": { "properties": { "requestBrandedContentPermission": { "type": "boolean" } }, "type": "object" }, "audience": { "$ref": "#/definitions/Audience" }, "autoAcceptApplicant": { "type": "boolean" }, "brief": { "type": "string" }, "campaign": { "$ref": "#/definitions/Campaign" }, "clicksMetrics": { "type": "number", "format": "double" }, "community": { "properties": { "instagramHandle": { "type": "string" } }, "type": "object" }, "communityId": { "type": "string" }, "contentDueDate": { "type": "string" }, "contentType": { "type": "string" }, "conversionsCountMetrics": { "type": "number", "format": "double" }, "conversionsValueMetrics": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "cpa": { "type": "number", "format": "double" }, "cpe": { "type": "number", "format": "double" }, "cpeGoal": { "type": "number", "format": "double" }, "cpm": { "type": "number", "format": "double" }, "cpmGoal": { "type": "number", "format": "double" }, "cpp": { "type": "number", "format": "double" }, "committedAmount": { "type": "number", "format": "double", "x-nullable": true }, "paidAmount": { "type": "number", "format": "double", "x-nullable": true }, "readyAmount": { "type": "number", "format": "double", "x-nullable": true }, "roiValue": { "type": "number", "format": "double", "x-nullable": true }, "createdAt": { "type": "string" }, "description": { "type": "string" }, "draftDueDate": { "type": "string" }, "conceptDueDate": { "type": "string" }, "endDate": { "type": "string" }, "engagementRateGoal": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "engagementsGoal": { "type": "number", "format": "double" }, "engagementsMetrics": { "type": "number", "format": "double" }, "ftcHashtag": { "type": "string" }, "fulfilled": { "type": "number", "format": "double" }, "globalUserListDefinitionId": { "type": "number", "format": "double" }, "hasPointsEnabled": { "type": "boolean" }, "hasScheduledNotifications": { "type": "boolean" }, "hideOnIcm": { "type": "boolean" }, "id": { "type": "number", "format": "double" }, "image": { "type": "string" }, "impressions": { "type": "number", "format": "double" }, "impressionsGoal": { "type": "number", "format": "double" }, "impressionsMetrics": { "type": "number", "format": "double" }, "incentive": { "$ref": "#/definitions/Incentive" }, "incentives": { "items": { "$ref": "#/definitions/Incentive" }, "type": "array" }, "influencerReviewDeliverable": { "properties": { "listId": { "type": "number", "format": "double" }, "count": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" } }, "type": "object" }, "internalDescription": { "type": "string" }, "isAutoCreated": { "type": "boolean" }, "isLaterCreatorExperienceEnabled": { "type": "boolean" }, "isPrimaryReferralActivity": { "type": "boolean" }, "listId": { "type": "number", "format": "double" }, "listDeliverables": { "items": { "$ref": "#/definitions/ListDeliverable" }, "type": "array" }, "locale": { "type": "string" }, "mainType": { "type": "string" }, "multipleActivations": { "type": "boolean" }, "name": { "type": "string" }, "notInCommunity": { "type": "boolean" }, "numberOfInfluencers": { "type": "number", "format": "double" }, "openGraphTags": { "type": "string" }, "pending": { "type": "number", "format": "double" }, "points": { "properties": { "max": { "type": "number", "format": "double" }, "min": { "type": "number", "format": "double" } }, "type": "object" }, "posts": { "type": "number", "format": "double" }, "primaryNetwork": { "type": "string" }, "programId": { "type": "number", "format": "double" }, "ready": { "type": "number", "format": "double" }, "requiredHashtag": { "type": "string" }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "brandSuitabilityGuidelines": { "type": "string" }, "shareableReportLink": { "type": "string" }, "startDate": { "type": "string" }, "status": { "type": "string" }, "termsOfServiceLink": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "workflowStatuses": { "items": { "$ref": "#/definitions/ListCustomStatus" }, "type": "array" }, "workflowSummary": { "properties": { "completed": { "type": "number", "format": "double" }, "participants": { "type": "number", "format": "double" }, "applicants": { "type": "number", "format": "double" }, "candidates": { "type": "number", "format": "double" }, "rejected": { "type": "number", "format": "double" }, "accepted": { "type": "number", "format": "double" } }, "type": "object" } }, "required": [ "communityId", "id" ], "type": "object", "additionalProperties": false }, "Campaign": { "properties": { "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "description": { "type": "string" }, "brand": { "$ref": "#/definitions/Brand" }, "actionGroups": { "items": { "$ref": "#/definitions/ActionGroup" }, "type": "array" }, "hasActivations": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "IncentiveClaim": { "properties": { "address": { "type": "string" }, "age": { "type": "number", "format": "double" }, "clickCount": { "type": "number", "format": "double" }, "conversionCount": { "type": "number", "format": "double" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "engagementCount": { "type": "number", "format": "double" }, "facebookFriendCount": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "gender": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "lastName": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "mostRecentRewardFulfilledAt": { "type": "string" }, "profilePictureLink": { "type": "string" }, "promocode": { "type": "string" } }, "type": "object", "additionalProperties": false }, "IncentiveTermsAndConditions": { "properties": { "params": { "additionalProperties": false, "type": "object" }, "preview": { "type": "string" }, "template": { "type": "string" } }, "type": "object", "additionalProperties": false }, "IncentiveUnlockEvent": { "type": "string", "enum": [ "acceptance", "completion", "pending_shipment", "pending_payment" ], "x-nullable": false }, "StripeSupportedCurrencyCodes": { "type": "string", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD" ], "x-nullable": false }, "TipaltiSupportedCurrencyCodes": { "type": "string", "enum": [ "USD", "EUR", "GBP", "CAD" ], "x-nullable": false }, "MavrckSupportedCurrencies": { "type": "object" }, "NullableBonusTierCurrencyCode": { "type": "string", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", null ], "x-nullable": true }, "BonusTier": { "description": "Swagger 2 representation of a tiered bonus entry.\n\n`upperBound` is required for `BOUNDED` tiers and must be omitted for\n`OPEN_ENDED` tiers. The bonus-tier validator enforces that conditional rule.\n\nValidation rules:\n- `bonusTiers` may contain at most 5 tiers.\n- Tiers must be sorted by `lowerBound`.\n- Adjacent tiers must be contiguous.\n- The final tier must be `OPEN_ENDED`.\n- `bonusTierCurrencyCode` is required when `bonusTiers` is non-empty.", "properties": { "type": { "type": "string", "enum": [ "BOUNDED", "OPEN_ENDED" ], "x-nullable": false }, "lowerBound": { "type": "number", "format": "double", "description": "Inclusive lower conversion/order bound for this payout tier. Must be non-negative." }, "upperBound": { "type": "number", "format": "double", "description": "Exclusive upper conversion/order bound for a `BOUNDED` tier." }, "bonusAmount": { "type": "number", "format": "double", "description": "Bonus payout amount in `bonusTierCurrencyCode`. Must be positive." } }, "required": [ "type", "lowerBound", "bonusAmount" ], "type": "object", "additionalProperties": false }, "Incentive": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "actionGroupStatus": { "type": "string" }, "allocatedWinnersCount": { "type": "number", "format": "double" }, "approximateRetailValue": { "type": "number", "format": "double" }, "cashPaymentAppId": { "type": "number", "format": "double" }, "cashPaymentAppProvider": { "type": "string", "x-nullable": true }, "claimedDynamicPromoCodes": { "type": "number", "format": "double" }, "claimedIncentivesCount": { "type": "number", "format": "double" }, "claimedIncentivesInfluencerCount": { "type": "number", "format": "double" }, "claims": { "items": { "$ref": "#/definitions/IncentiveClaim" }, "type": "array" }, "contestMetric": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "disqualifiedWinnersCount": { "type": "number", "format": "double" }, "endDate": { "type": "string", "x-nullable": true }, "exclusiveLinkCta": { "type": "string" }, "exclusiveLinkUrl": { "type": "string" }, "giftCardEmailTemplateId": { "type": "string" }, "giftCardOptionId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "image": { "type": "string" }, "incentiveDescription": { "type": "string" }, "incentiveStatus": { "type": "string" }, "incentiveTitle": { "type": "string" }, "multipleClaims": { "type": "boolean" }, "numberPointsRequired": { "type": "number", "format": "double" }, "printableCoupon": { "type": "string" }, "promocode": { "type": "string" }, "promocodeTermsAndConditions": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "rewardId": { "type": "string" }, "rewardWinType": { "type": "string" }, "startDate": { "type": "string", "x-nullable": true }, "sweepsRules": { "type": "string" }, "sweepstakesUrl": { "type": "string" }, "sweepstakesWinnersQty": { "type": "number", "format": "double" }, "termsAndConditions": { "$ref": "#/definitions/IncentiveTermsAndConditions" }, "totalDynamicPromoCodes": { "type": "number", "format": "double" }, "type": { "type": "string" }, "unlockEvent": { "$ref": "#/definitions/IncentiveUnlockEvent" }, "unlockType": { "type": "string" }, "winnerSelectionMethod": { "type": "string" }, "winnersSelectedCount": { "type": "number", "format": "double" }, "valueCurrencyCode": { "$ref": "#/definitions/MavrckSupportedCurrencies" }, "costCurrencyCode": { "$ref": "#/definitions/MavrckSupportedCurrencies" }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode", "description": "Currency code used for all tiered bonus amounts. Required when `bonusTiers` is non-empty." }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true, "description": "Tiered bonus payout ladder. Must be sorted, contiguous, contain at most 5 tiers, and end with one `OPEN_ENDED` tier." }, "discountCodeId": { "type": "string" }, "shippingCodeId": { "type": "string" }, "couponActivation": { "type": "string" } }, "type": "object", "additionalProperties": false }, "NetworkName": { "type": "string", "enum": [ "Blog", "Facebook", "Facebook Group", "Facebook Live", "Facebook Reel", "Image", "Instagram", "Instagram Reel", "Instagram Story", "LinkedIn", "Pinterest", "Snapchat Story", "TikTok", "Twitch Stream", "Twitter", "Video", "YouTube Video", "YouTube Shorts" ], "x-nullable": false }, "ListDeliverable": { "properties": { "contentType": { "$ref": "#/definitions/NetworkSlug" }, "contentTypeName": { "$ref": "#/definitions/NetworkName" }, "count": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "updatedBy": { "type": "number", "format": "double" } }, "required": [ "contentType", "contentTypeName", "count", "id", "listId" ], "type": "object", "additionalProperties": false }, "BudgetReferenceIdType": { "type": "string", "enum": [ "IROF", "OPPORTUNITY" ], "x-nullable": false }, "Administrator": { "properties": { "id": { "type": "number", "format": "double" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string", "x-nullable": true }, "image": { "type": "string", "x-nullable": true }, "approves": { "type": "boolean" }, "createdAt": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ConversationTemplate": { "properties": { "category": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "$ref": "#/definitions/Administrator" }, "communityId": { "type": "string" }, "html": { "type": "string" }, "id": { "type": "number", "format": "double" }, "isArchived": { "type": "boolean" }, "lastModifiedBy": { "$ref": "#/definitions/Administrator" }, "subject": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "number", "format": "double" } }, "required": [ "category", "createdAt", "html", "id", "isArchived", "title", "updatedAt" ], "type": "object", "additionalProperties": false }, "ListCustomStatus": { "properties": { "templates": { "items": { "$ref": "#/definitions/ConversationTemplate" }, "type": "array" }, "statusOrder": { "type": "number", "format": "double" }, "slug": { "type": "string" }, "phase": { "type": "string" }, "linkedStages": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" }, "id": { "type": "number", "format": "double" }, "enabled": { "type": "boolean" }, "disabled": { "type": "boolean" }, "custom": { "type": "boolean" }, "ctaLabel": { "type": "string" }, "auxiliaryLabel": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" } }, "type": "object" }, "ConversionTag": { "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "isActive": { "type": "boolean" }, "isConversionValueEnabled": { "type": "boolean" } }, "required": [ "id", "name", "isActive", "isConversionValueEnabled" ], "type": "object", "additionalProperties": false }, "MetaInformation": { "properties": { "description": { "type": "string" }, "ftcHashtag": { "type": "string" }, "image": { "type": "string" }, "title": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TrackingLink": { "properties": { "action": { "$ref": "#/definitions/Action" }, "communityId": { "type": "string" }, "conversionId": { "type": "string" }, "conversions": { "type": "number", "format": "double" }, "conversionsValue": { "type": "number", "format": "double" }, "destinationUrl": { "type": "string" }, "domain": { "type": "string" }, "domainId": { "type": "string" }, "id": { "type": "number", "format": "double" }, "parentId": { "type": "number", "format": "double" }, "isAffiliate": { "type": "boolean" }, "isDeleted": { "type": "string" }, "lastUpdated": { "type": "string" }, "membershipId": { "type": "string" }, "metaInformation": { "$ref": "#/definitions/MetaInformation" }, "name": { "type": "string" }, "numClicks": { "type": "number", "format": "double" }, "providerCode": { "type": "string" }, "providerName": { "type": "string" }, "shortLink": { "type": "string" }, "title": { "type": "string" }, "trackingPixelCode": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "isArchived": { "type": "boolean" }, "archivedAt": { "type": "string", "format": "date-time" } }, "required": [ "isArchived", "archivedAt" ], "type": "object", "additionalProperties": false }, "Links": { "properties": { "deep": { "type": "string" }, "normal": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Network": { "properties": { "clicks": { "type": "boolean" }, "comments": { "type": "boolean" }, "impressions": { "type": "boolean" }, "key": { "type": "string" }, "likes": { "type": "boolean" }, "reach": { "type": "boolean" }, "shares": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Artifact": { "properties": { "before": { "type": "string" }, "example": { "type": "string" }, "hashtag": { "type": "string" }, "key": { "type": "string" }, "link": { "$ref": "#/definitions/TrackingLink" }, "linkReference": { "type": "string" }, "metaInformation": { "$ref": "#/definitions/MetaInformation" }, "placeholder": { "type": "string" }, "resourceId": { "type": "string" }, "resourceUrl": { "type": "string" } }, "type": "object", "additionalProperties": false }, "NetworkOperation": { "properties": { "links": { "$ref": "#/definitions/Links" }, "network": { "$ref": "#/definitions/Network" }, "artifact": { "$ref": "#/definitions/Artifact" } }, "type": "object", "additionalProperties": false }, "BazaarVoiceAppProduct": { "properties": { "reviewProductId": { "type": "number", "format": "double" }, "externalBazaarProductId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "PowerReviewsApp": { "properties": { "apiKey": { "type": "string" }, "communityId": { "type": "string" }, "environment": { "type": "string" }, "id": { "type": "number", "format": "double" }, "locale": { "type": "string" }, "merchantId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "apiKey", "communityId", "id", "locale", "merchantId", "name" ], "type": "object", "additionalProperties": false }, "PowerReviewsPage": { "properties": { "PowerReviewsApp": { "items": { "$ref": "#/definitions/PowerReviewsApp" }, "type": "array" }, "externalPageId": { "type": "string" }, "id": { "type": "number", "format": "double" }, "powerReviewsAppId": { "type": "string" }, "reviewProductId": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "YotpoAppProduct": { "properties": { "reviewProductId": { "type": "number", "format": "double" }, "youtpoProductId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Product": { "properties": { "bazaarVoiceAppProduct": { "$ref": "#/definitions/BazaarVoiceAppProduct" }, "communityId": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "number", "format": "double" }, "image": { "type": "string" }, "powerReviewsPage": { "$ref": "#/definitions/PowerReviewsPage" }, "title": { "type": "string" }, "yotpoAppProduct": { "$ref": "#/definitions/YotpoAppProduct" } }, "type": "object", "additionalProperties": false }, "RoutingOptions": { "properties": { "cta": { "type": "string" }, "mode": { "type": "string" }, "redirect_url": { "type": "string" } }, "type": "object", "additionalProperties": false }, "Routing": { "properties": { "not_eligible": { "$ref": "#/definitions/RoutingOptions" }, "success": { "$ref": "#/definitions/RoutingOptions" } }, "type": "object", "additionalProperties": false }, "ReviewForm": { "properties": { "id": { "type": "number", "format": "double" }, "reviewProductId": { "type": "number", "format": "double" }, "action": { "$ref": "#/definitions/Action" }, "product": { "$ref": "#/definitions/Product" }, "questions": { "items": { "$ref": "#/definitions/Question" }, "type": "array" }, "incentivized": { "type": "boolean" }, "responses": { "items": { "properties": { "questionResponses": { "items": { "additionalProperties": false, "type": "object" }, "type": "array" }, "membership": { "$ref": "#/definitions/Membership" } }, "type": "object" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "ReviewFormResponse": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "rating": { "type": "number", "format": "double" }, "reviewCharacterCount": { "type": "number", "format": "double" }, "fullName": { "type": "string" }, "profilePic": { "type": "string" }, "questionResponses": { "items": { "$ref": "#/definitions/QuestionResponse" }, "type": "array" }, "createdAt": { "type": "string", "format": "date-time" }, "reviewForm": { "$ref": "#/definitions/ReviewForm" }, "product": { "$ref": "#/definitions/Product" } }, "type": "object", "additionalProperties": false }, "ResponseBody_ReviewFormResponse-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/ReviewFormResponse" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ViewQueryParam": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "instagramProfileId": { "type": "number", "format": "double" }, "facebookProfileId": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "InstanceUserMaterializedViewRequestBody": { "properties": { "data": { "items": { "$ref": "#/definitions/ViewQueryParam" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "InfluencerCampaignContentApprovalStatus": { "type": "string", "enum": [ "PENDING", "APPROVED", "REJECTED" ], "x-nullable": false }, "InfluencerCampaignContent": { "properties": { "views": { "type": "number", "format": "double" }, "video": { "type": "string" }, "text": { "type": "string" }, "shares": { "type": "number", "format": "double" }, "reach": { "type": "number", "format": "double" }, "postLink": { "type": "string" }, "postDate": { "type": "string", "format": "date-time" }, "network": { "type": "number", "format": "double" }, "likes": { "type": "number", "format": "double" }, "isDeleted": { "type": "boolean" }, "impressionsSource": { "type": "string" }, "image": { "type": "string" }, "id": { "type": "number", "format": "double" }, "estimatedImpressions": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "carouselPosts": { "type": "string" }, "approvalStatus": { "$ref": "#/definitions/InfluencerCampaignContentApprovalStatus" } }, "required": [ "network", "id", "engagements", "conversionValue", "conversions" ], "type": "object" }, "ActivationResponse": { "properties": { "action": { "$ref": "#/definitions/Action" }, "approvalStatus": { "type": "string" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "content": { "$ref": "#/definitions/InfluencerCampaignContent" }, "createdAt": { "type": "string", "format": "date-time" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "string" }, "membership": { "$ref": "#/definitions/Membership" }, "membershipId": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "selfReported": { "type": "boolean" } }, "required": [ "action", "approvalStatus", "contactInfo", "content", "createdAt", "globalUserId", "id", "membership", "membershipId", "profilePicture", "selfReported" ], "type": "object", "additionalProperties": false }, "SelfReportedActivationContent": { "properties": { "additionalUrls": { "items": { "type": "string" }, "type": "array" }, "clicks": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "estimatedImpressions": { "type": "number", "format": "double" }, "image": { "type": "string" }, "likes": { "type": "number", "format": "double" }, "mavelyUrls": { "items": { "type": "string" }, "type": "array" }, "network": { "$ref": "#/definitions/NetworkSlug" }, "postDate": { "type": "string" }, "postLink": { "type": "string" }, "privacy": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "reactions": { "type": "number", "format": "double" }, "saved": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "text": { "type": "string" }, "video": { "type": "string" }, "views": { "type": "number", "format": "double" } }, "required": [ "network" ], "type": "object", "additionalProperties": false }, "SelfReportedActivation": { "properties": { "associatedAccount": { "type": "object", "properties": { "averageEngagements": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "primaryAccount": { "type": "boolean" }, "profilePicture": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "username": { "type": "string" } } }, "isApproved": { "type": "boolean" }, "content": { "$ref": "#/definitions/SelfReportedActivationContent" }, "selfReported": { "type": "boolean" } }, "required": [ "content" ], "type": "object", "additionalProperties": false }, "SelfReportedActivationBody": { "properties": { "activation": { "$ref": "#/definitions/SelfReportedActivation" }, "postId": { "type": "string" } }, "type": "object" }, "SelfReportedActivationContentFile": { "properties": { "fileUrl": { "type": "string" }, "caption": { "type": "string" } }, "type": "object" }, "SelfReportedActivationContentFiles": { "items": { "$ref": "#/definitions/SelfReportedActivationContentFile" }, "type": "array" }, "LegacySelfReportedActivationBody": { "type": "object", "properties": {} }, "InfluencerCampaignRewardWin": { "properties": { "valueCurrenyCode": { "type": "string" }, "value": { "type": "number", "format": "double" }, "type": { "type": "string" }, "shippingCodeRedeemId": { "type": "string", "x-nullable": true }, "trackingNumber": { "type": "string" }, "rewardTitle": { "type": "string" }, "orderNumber": { "type": "string" }, "isFulfilled": { "type": "boolean" }, "giftCardOptionId": { "type": "number", "format": "double" }, "giftCardDescription": { "type": "string" }, "giftCardBrandName": { "type": "string" }, "fulfillmentStatus": { "type": "string" }, "eligibleOnEventType": { "type": "string" }, "discountCodeRedeemId": { "type": "string", "x-nullable": true }, "costCurrenyCode": { "type": "string" }, "cost": { "type": "number", "format": "double" }, "comment": { "type": "string" }, "cashPaymentProvider": { "type": "string" }, "cashPaymentAppId": { "type": "number", "format": "double" }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true, "description": "Sorted, contiguous tiered bonus payout ladder for this creator-visible reward win.\nContains at most 5 tiers and ends with exactly one `OPEN_ENDED` tier." }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode", "description": "ISO-style currency code used for all `bonusTiers[].bonusAmount` values.\nRequired when `bonusTiers` is non-empty." } }, "required": [ "valueCurrenyCode", "type", "shippingCodeRedeemId", "rewardTitle", "isFulfilled", "fulfillmentStatus", "discountCodeRedeemId", "costCurrenyCode" ], "type": "object" }, "Pick_InfluencerOngoingCampaign.-or-actionGroupId-or-actionGroupTitle-or-applicationImage-or-communityId-or-id-or-invitedAt-or-programDescription-or-programLogo-or-programName-or-rewardWins-or-title_": { "properties": { "id": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double", "description": "Deprecated. Use 'id' instead." }, "actionGroupTitle": { "type": "string", "description": "Deprecated. Use 'title' instead." }, "applicationImage": { "type": "string" }, "communityId": { "type": "string" }, "invitedAt": { "type": "string", "format": "date-time" }, "programDescription": { "type": "string", "description": "\"brand\" and \"program\" are equivalent.\nIn Later Social, \"brand\" is the term used to represent a campaign sponsor to influencers.\nIn Later Influence, \"program\" is the term used to represent the instance's influencer-facing identity.\n\nThese \"program properties\" are returned by GET /later-influencers/{laterInfluencerId}/campaigns/{campaignId}" }, "programLogo": { "type": "string" }, "programName": { "type": "string" }, "rewardWins": { "items": { "$ref": "#/definitions/InfluencerCampaignRewardWin" }, "type": "array" }, "title": { "type": "string" } }, "required": [ "actionGroupId", "communityId", "programLogo", "programName", "rewardWins" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "InfluencerDroppedCampaignStatusSlug": { "type": "string", "enum": [ "dropped" ], "x-nullable": false }, "InfluencerOngoingCampaignStatusSlug": { "type": "string", "enum": [ "candidate", "invited", "applied", "deliverable", "pending_confirmation", "pending_shipment", "pending_concept", "concept_review", "pending_draft", "draft_review", "pending_content", "content_review", "pending_payment", "complete" ], "x-nullable": false }, "InfluencerCampaignStatusSlug": { "type": "object" }, "InfluencerCampaignDropReason": { "type": "string", "enum": [ "creator_declined", "brand_dropped" ], "x-nullable": false }, "LaterInfluencerCampaignPlatformExperienceDto": { "properties": { "externalUrl": { "type": "string" }, "laterCreatorExperience": { "type": "boolean" }, "mavelyCreatorExperience": { "type": "boolean" } }, "required": [ "externalUrl", "laterCreatorExperience", "mavelyCreatorExperience" ], "type": "object" }, "LaterInfluencerCampaignListItemDto": { "type": "object", "properties": {} }, "PaginatedResponse_LaterInfluencerCampaignListItemDto_": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" } }, "required": [ "totalCount", "offset", "limit" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/LaterInfluencerCampaignListItemDto" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object" }, "LaterInfluencerCampaignListDto": { "$ref": "#/definitions/PaginatedResponse_LaterInfluencerCampaignListItemDto_" }, "LimitedCampaignApplicationQuestion": { "properties": { "type": { "type": "string" }, "setElements": { "items": { "properties": { "markUpDisplayLabel": { "type": "string", "x-nullable": true }, "displayLabel": { "type": "string" }, "key": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "displayLabel", "key", "id" ], "type": "object" }, "type": "array" }, "required": { "type": "boolean" }, "order": { "type": "number", "format": "double" }, "name": { "type": "string" }, "multi": { "type": "boolean" }, "key": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "markUpDescription": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "archived": { "type": "boolean" } }, "required": [ "type", "setElements", "required", "order", "name", "multi", "key", "id", "description", "archived" ], "type": "object" }, "InfluencerCampaignDeliverable": { "properties": { "count": { "type": "number", "format": "double" }, "contentType": { "type": "string" } }, "required": [ "count", "contentType" ], "type": "object" }, "Pick_InfluencerDraftContent.contentType-or-contentUrl-or-createdAt-or-feedback-or-feedbackList-or-notes-or-status-or-text-or-threadId_": { "properties": { "text": { "type": "string" }, "status": { "type": "string", "description": "`status` should be 'approved', 'conditionally_approved', 'pending', 'rejected', or 'rejected_no_notification'." }, "notes": { "type": "string" }, "feedback": { "type": "string" }, "feedbackList": { "items": { "$ref": "#/definitions/DraftContentFeedbackEntry" }, "type": "array" }, "contentUrl": { "type": "string" }, "contentType": { "$ref": "#/definitions/NetworkSlug" }, "createdAt": { "type": "string", "format": "date-time" }, "threadId": { "type": "string" } }, "required": [ "status", "feedbackList", "contentType", "createdAt", "threadId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "InfluencerCampaignDraftContent": { "$ref": "#/definitions/Pick_InfluencerDraftContent.contentType-or-contentUrl-or-createdAt-or-feedback-or-feedbackList-or-notes-or-status-or-text-or-threadId_" }, "InfluencerCampaignStatus": { "properties": { "phase": { "type": "string" }, "slug": { "type": "string" }, "label": { "type": "string" }, "statusOrder": { "type": "string" }, "isDeleted": { "type": "boolean" }, "id": { "type": "number", "format": "double" } }, "required": [ "label", "id" ], "type": "object" }, "InfluencerCampaignTrackingLink": { "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "image": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" }, "actionId": { "type": "string" } }, "required": [ "url", "type", "name", "actionId" ], "type": "object" }, "InfluencerCampaignAssignedLink": { "properties": { "providerName": { "type": "string" }, "providerCode": { "type": "string" }, "isAffiliate": { "type": "boolean" }, "url": { "type": "string" } }, "required": [ "providerName", "providerCode", "isAffiliate", "url" ], "type": "object" }, "Pick_InfluencerOngoingCampaign.Exclude_keyofInfluencerOngoingCampaign.productReviewDeliverables__": { "properties": { "id": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "status": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double", "description": "Deprecated. Use 'id' instead." }, "actionGroupTitle": { "type": "string", "description": "Deprecated. Use 'title' instead." }, "applicationImage": { "type": "string" }, "communityId": { "type": "string" }, "invitedAt": { "type": "string", "format": "date-time" }, "programDescription": { "type": "string", "description": "\"brand\" and \"program\" are equivalent.\nIn Later Social, \"brand\" is the term used to represent a campaign sponsor to influencers.\nIn Later Influence, \"program\" is the term used to represent the instance's influencer-facing identity.\n\nThese \"program properties\" are returned by GET /later-influencers/{laterInfluencerId}/campaigns/{campaignId}" }, "programLogo": { "type": "string" }, "programName": { "type": "string" }, "rewardWins": { "items": { "$ref": "#/definitions/InfluencerCampaignRewardWin" }, "type": "array" }, "title": { "type": "string" }, "actionGroupStatus": { "type": "string", "description": "Deprecated. Use 'status' instead." }, "applicationDescription": { "type": "string" }, "applicationTitle": { "type": "string" }, "brief": { "type": "string" }, "campaignContentDueDate": { "type": "string", "format": "date-time" }, "campaignDraftDueDate": { "type": "string", "format": "date-time" }, "clicks": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "cpe": { "type": "number", "format": "double" }, "cpm": { "type": "number", "format": "double" }, "cpp": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "ftcHashtag": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "influencerContentDueDate": { "type": "string", "format": "date-time" }, "influencerDraftDueDate": { "type": "string", "format": "date-time" }, "listMemberStatus": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "posts": { "type": "number", "format": "double" }, "publicSummary": { "type": "string", "x-nullable": true }, "requireEthnicityQuestion": { "type": "boolean" }, "requireFacebook": { "type": "boolean" }, "requireInstagram": { "type": "boolean" }, "requirePinterest": { "type": "boolean" }, "requireTiktok": { "type": "boolean" }, "requireTwitter": { "type": "boolean" }, "requireMavely": { "type": "boolean" }, "requiredHashtag": { "type": "string", "x-nullable": true }, "statusLabel": { "type": "string" }, "statusSlug": { "$ref": "#/definitions/InfluencerCampaignStatusSlug" }, "value": { "type": "number", "format": "double" }, "youtubeHashtag": { "type": "string", "x-nullable": true }, "applicationQuestions": { "items": { "$ref": "#/definitions/LimitedCampaignApplicationQuestion" }, "type": "array" }, "content": { "items": { "$ref": "#/definitions/InfluencerCampaignContent" }, "type": "array" }, "deliverables": { "items": { "$ref": "#/definitions/InfluencerCampaignDeliverable" }, "type": "array" }, "draftContent": { "items": { "$ref": "#/definitions/InfluencerCampaignDraftContent" }, "type": "array" }, "statuses": { "items": { "$ref": "#/definitions/InfluencerCampaignStatus" }, "type": "array" }, "trackingLinks": { "items": { "type": "object" }, "type": "array" } }, "required": [ "listMemberId", "status", "actionGroupId", "communityId", "programLogo", "programName", "rewardWins", "globalUserId", "listMemberStatus", "membershipId", "requireFacebook", "requireInstagram", "requirePinterest", "requireTwitter", "requireMavely", "statusLabel", "applicationQuestions", "content", "deliverables", "draftContent", "statuses", "trackingLinks" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_InfluencerOngoingCampaign.productReviewDeliverables_": { "$ref": "#/definitions/Pick_InfluencerOngoingCampaign.Exclude_keyofInfluencerOngoingCampaign.productReviewDeliverables__", "description": "Construct a type with the properties of T except for those in type K." }, "InfluencerDroppedCampaign": { "properties": { "dropReason": { "$ref": "#/definitions/InfluencerCampaignDropReason" }, "listMemberId": { "type": "number", "format": "double" }, "applicationTitle": { "type": "string" }, "statusSlug": { "$ref": "#/definitions/InfluencerDroppedCampaignStatusSlug" } }, "required": [ "dropReason", "listMemberId", "statusSlug" ], "type": "object" }, "LaterInfluencerCampaign": { "type": "object" }, "ConceptReviewStatus": { "type": "string", "enum": [ "approved", "conditionally_approved", "pending", "rejected", "rejected_no_notification" ], "x-nullable": false }, "Pick_AdministratorAccountDomain.email-or-first_name-or-image-or-last_name_": { "properties": { "image": { "type": "string", "x-nullable": true }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" } }, "required": [ "email" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "AdministratorAccountView": { "$ref": "#/definitions/Pick_AdministratorAccountDomain.email-or-first_name-or-image-or-last_name_" }, "ConceptContentFeedbackEntry": { "properties": { "id": { "type": "number", "format": "double" }, "conceptId": { "type": "number", "format": "double" }, "accountId": { "type": "number", "format": "double", "x-nullable": true }, "administratorAccount": { "$ref": "#/definitions/AdministratorAccountView" }, "text": { "type": "string" }, "commenterType": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" } }, "required": [ "id", "conceptId", "accountId", "text", "commenterType", "createdAt", "isArchived" ], "type": "object", "additionalProperties": false }, "InfluencerConceptContentFile": { "properties": { "codec": { "type": "string", "x-nullable": true }, "conceptId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "originalUrl": { "type": "string", "x-nullable": true }, "size": { "type": "number", "format": "double" }, "type": { "type": "string" }, "url": { "type": "string" } }, "required": [ "conceptId", "id", "name", "type", "url" ], "type": "object", "additionalProperties": false }, "ConceptContentCommentEntry": { "properties": { "id": { "type": "number", "format": "double" }, "conceptId": { "type": "number", "format": "double" }, "accountId": { "type": "number", "format": "double", "x-nullable": true }, "administratorAccount": { "$ref": "#/definitions/AdministratorAccountView" }, "commenterName": { "type": "string", "x-nullable": true }, "commenterType": { "type": "string" }, "text": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" } }, "required": [ "id", "conceptId", "accountId", "commenterName", "commenterType", "text", "createdAt", "isArchived" ], "type": "object", "additionalProperties": false }, "Pick_ConceptViewed.conceptId-or-email-or-viewedAt_": { "properties": { "email": { "type": "string" }, "viewedAt": { "type": "string", "format": "date-time" }, "conceptId": { "type": "number", "format": "double" } }, "required": [ "email", "viewedAt", "conceptId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Pick_InfluencerConceptContent.Exclude_keyofInfluencerConceptContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId__": { "properties": { "id": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "text": { "type": "string" }, "status": { "$ref": "#/definitions/ConceptReviewStatus" }, "notes": { "type": "string" }, "feedbackList": { "items": { "$ref": "#/definitions/ConceptContentFeedbackEntry" }, "type": "array" }, "contentUrl": { "type": "string" }, "contentType": { "type": "string", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "isArchived": { "type": "boolean" }, "archivedByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "archivedByGlobalUserId": { "type": "number", "format": "double", "x-nullable": true }, "archivedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "files": { "items": { "$ref": "#/definitions/InfluencerConceptContentFile" }, "type": "array" }, "comments": { "items": { "$ref": "#/definitions/ConceptContentCommentEntry" }, "type": "array" }, "threadId": { "type": "string" }, "viewed": { "$ref": "#/definitions/Pick_ConceptViewed.conceptId-or-email-or-viewedAt_" } }, "required": [ "id", "listMemberId", "status", "feedbackList", "createdAt", "updatedAt", "isArchived", "archivedByAccountId", "archivedByGlobalUserId", "archivedAt", "files", "comments", "threadId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_InfluencerConceptContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId_": { "$ref": "#/definitions/Pick_InfluencerConceptContent.Exclude_keyofInfluencerConceptContent.uploaderType-or-uploaderAccountId-or-uploaderGlobalUserId__", "description": "Construct a type with the properties of T except for those in type K." }, "InfluencerConceptContentDto": { "type": "object", "properties": {} }, "LaterInfluencerProductDto": { "properties": { "description": { "type": "string" }, "title": { "type": "string" }, "image": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "title", "id" ], "type": "object" }, "LaterInfluencerProductReviewMetadataDto": { "properties": { "submittedReviews": { "items": { "properties": { "product": { "$ref": "#/definitions/LaterInfluencerProductDto" } }, "required": [ "product" ], "type": "object" }, "type": "array" }, "pendingStaticReviews": { "items": { "properties": { "product": { "$ref": "#/definitions/LaterInfluencerProductDto" } }, "required": [ "product" ], "type": "object" }, "type": "array" }, "pendingDynamicReviewsCount": { "type": "number", "format": "double" } }, "required": [ "submittedReviews", "pendingStaticReviews", "pendingDynamicReviewsCount" ], "type": "object" }, "LaterInfluencerCampaignDto": { "type": "object", "properties": {} }, "InfluencerYtbcCampaignCodeResponse": { "properties": { "data": { "properties": { "campaignCode": { "type": "string" } }, "required": [ "campaignCode" ], "type": "object" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "UpdateCampaignMembershipPutBody": { "properties": { "participating": { "type": "boolean" } }, "required": [ "participating" ], "type": "object", "additionalProperties": false }, "InfluencerDraftContentGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerDraftContentDto" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "InfluencerDraftContentPostBody": { "properties": { "contentType": { "$ref": "#/definitions/NetworkSlug" }, "contentUrl": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/InfluencerDraftContentPostFile" }, "type": "array" }, "notes": { "type": "string" }, "text": { "type": "string" }, "threadId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" } }, "required": [ "contentType" ], "type": "object", "additionalProperties": false }, "InfluencerConceptContentGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerConceptContentDto" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "InfluencerConceptContentPostFile": { "properties": { "originalFile": { "properties": { "path": { "type": "string" } }, "required": [ "path" ], "type": "object" }, "isUploaded": { "type": "boolean" }, "lastModified": { "type": "number", "format": "double" }, "url": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "number", "format": "double" }, "name": { "type": "string" }, "code": { "type": "string" } }, "type": "object" }, "InfluencerConceptContentPostBody": { "properties": { "contentType": { "type": "string" }, "contentUrl": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/InfluencerConceptContentPostFile" }, "type": "array" }, "notes": { "type": "string" }, "text": { "type": "string" }, "threadId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "LaterInfluencerDataPointDefinitionDto": { "properties": { "description": { "type": "string", "x-nullable": true }, "archived": { "type": "boolean" }, "multi": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" }, "key": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" } }, "required": [ "description", "archived", "multi", "name", "type", "key", "id" ], "type": "object" }, "LaterInfluencersDataPointDto": { "properties": { "dataPointDefinition": { "$ref": "#/definitions/LaterInfluencerDataPointDefinitionDto" }, "value": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "isConfirmedByMember": { "type": "boolean" }, "lastEditedByAccountId": { "type": "number", "format": "double" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "number", "format": "double" } }, "required": [ "dataPointDefinition", "value", "membershipId", "isConfirmedByMember", "lastEditedByAccountId", "updatedAt", "createdAt", "id" ], "type": "object" }, "MembershipDataPointResponses": { "properties": {}, "additionalProperties": { "type": "object" }, "type": "object" }, "ListMemberPaymentRecipientResponse": { "properties": { "id": { "type": "number", "format": "double" }, "list_member_id": { "type": "number", "format": "double" }, "payment_recipient_uuid": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "id", "list_member_id", "payment_recipient_uuid", "created_at", "updated_at" ], "type": "object", "additionalProperties": false }, "ListMemberPaymentRecipientUpsertRequest": { "properties": { "payment_recipient_uuid": { "type": "string" } }, "required": [ "payment_recipient_uuid" ], "type": "object", "additionalProperties": false }, "SigningData": { "properties": { "signature": { "type": "string" }, "policy": { "type": "string" }, "bucket": { "type": "string" }, "awsKey": { "type": "string" } }, "required": [ "signature", "policy", "bucket", "awsKey" ], "type": "object" }, "FileUploadPoliciesPostBody": { "properties": { "fileName": { "type": "string" } }, "required": [ "fileName" ], "type": "object", "additionalProperties": false }, "UrlMetadataGetResponse": { "properties": { "video": { "type": "string" }, "type": { "type": "string" }, "metaInformation": { "$ref": "#/definitions/MetaInformation" }, "networkMetadata": { "properties": { "instagram": { "properties": { "comments": { "type": "string" }, "likes": { "type": "string" } }, "type": "object" } }, "type": "object" }, "images": { "items": { "type": "string" }, "type": "array" }, "article": { "type": "string" } }, "required": [ "type", "metaInformation", "networkMetadata" ], "type": "object", "additionalProperties": false }, "LaterInfluencerProductPageDto": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" } }, "required": [ "totalCount", "offset", "limit" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/LaterInfluencerProductDto" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object" }, "AuthResponse": { "properties": { "message": { "type": "string" } }, "required": [ "message" ], "type": "object", "additionalProperties": false }, "AuthEmailRequestBody": { "properties": { "password": { "type": "string" }, "email": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" } }, "required": [ "password", "email", "actionGroupId" ], "type": "object" }, "AuthFacebookRequestBody": { "properties": { "facebookUserId": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" } }, "required": [ "facebookUserId", "actionGroupId" ], "type": "object" }, "Components.Schemas.Creator": { "properties": { "creatorId": { "type": "string" }, "displayName": { "type": "string" }, "handleName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "insights": { "type": "string" }, "insightsUpdatedAt": { "type": "string" }, "profileImage": { "type": "string" }, "status": { "type": "string", "enum": [ "IN", "INVALID", "INVITED", "NOT_IN" ], "x-nullable": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "active": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "LaterInfluencerTikTokAuthBody": { "properties": { "handleName": { "type": "string" }, "creatorId": { "type": "string" }, "accessToken": { "type": "string" } }, "required": [ "handleName", "creatorId", "accessToken" ], "type": "object" }, "Pick_Components.Schemas.InviteLinkResponse.campaignId-or-handleName-or-inviteLinkExpiresAt-or-inviteLink_": { "properties": { "campaignId": { "type": "string" }, "handleName": { "type": "string" }, "inviteLinkExpiresAt": { "type": "number", "format": "double" }, "inviteLink": { "type": "string" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "ProductReviewFormFieldDto": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "maxLength": { "type": "number", "format": "double" }, "maxRating": { "type": "number", "format": "double" }, "minLength": { "type": "number", "format": "double" }, "minRating": { "type": "number", "format": "double" }, "required": { "type": "boolean" }, "type": { "type": "string", "enum": [ "textarea", "text", "file", "radio", "rating", "image", "select", "fingerprint" ], "x-nullable": false }, "options": { "items": { "properties": { "value": { "type": "string" }, "label": { "type": "string" } }, "required": [ "value", "label" ], "type": "object" }, "type": "array" } }, "required": [ "key", "required", "type" ], "type": "object", "additionalProperties": false }, "ProductReviewValuesDto": { "properties": {}, "type": "object", "additionalProperties": { "type": "object" } }, "LaterInfluencerProductReviewDto": { "properties": { "product": { "$ref": "#/definitions/LaterInfluencerProductDto" }, "fields": { "items": { "$ref": "#/definitions/ProductReviewFormFieldDto" }, "type": "array" }, "values": { "$ref": "#/definitions/ProductReviewValuesDto" } }, "required": [ "product", "fields" ], "type": "object", "additionalProperties": false }, "ProductReviewsPostBody": { "properties": { "data": { "$ref": "#/definitions/ProductReviewValuesDto" } }, "required": [ "data" ], "type": "object" }, "EmailSettings": { "type": "object", "properties": { "accentColor": { "type": "string" }, "buttonColor": { "type": "string" }, "id": { "type": "number", "format": "double" }, "logo": { "type": "string" }, "associatedWithCampaign": { "type": "boolean" }, "name": { "type": "string" } } }, "MessageSettings": { "properties": { "email": { "items": { "$ref": "#/definitions/EmailSettings" }, "type": "array" } }, "required": [ "email" ], "type": "object", "additionalProperties": false }, "InfluencerSettings": { "properties": { "isDeleted": { "type": "boolean" }, "messages": { "$ref": "#/definitions/MessageSettings" } }, "required": [ "isDeleted", "messages" ], "type": "object", "additionalProperties": false }, "EmailSettingsPayload": { "properties": { "communityId": { "type": "string" }, "isSubscribed": { "type": "boolean" } }, "required": [ "communityId", "isSubscribed" ], "type": "object", "additionalProperties": false }, "MessageSettingsPayload": { "properties": { "email": { "items": { "$ref": "#/definitions/EmailSettingsPayload" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "InfluencerSettingsPayload": { "properties": { "isDeleted": { "type": "boolean" }, "messages": { "$ref": "#/definitions/MessageSettingsPayload" }, "source": { "type": "string", "description": "An encrypted string provided by Later Infuence with information such as\nthe ID of the message (`messageId`) that prompted the user to unsubscribe.\nClient applications should not tamper with this value; they should pass it back to Later Influence as is.\n\nExample: Unsubscribe\n\nWhen a brand uses Later Influence to send a message to an influencer,\nthe platform almost always appends a link the influencer can use to unsubscribe from the brand's messages,\nin compliance with the USA's Federal Trade Commission requirements (CAN-SPAM Act):\nhttps://qa.mavrck.co/saf/email-preferences?id=${encryptedString}.\nThe client should pass the `id` query parameter back to Later Influence as `source`." } }, "type": "object", "additionalProperties": false }, "ExportData": { "properties": { "community": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "name", "id" ], "type": "object" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "activations": { "items": { "$ref": "#/definitions/Activation" }, "type": "array" }, "rewards": { "items": { "$ref": "#/definitions/Incentive" }, "type": "array" } }, "required": [ "community", "contactInfo", "activations", "rewards" ], "type": "object", "additionalProperties": false }, "ExportResponse": { "items": { "$ref": "#/definitions/ExportData" }, "type": "array" }, "StripeOnboardingLink": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "StripeDashboardLink": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "StripeOnboardingStatus": { "enum": [ "COMPLETE", "NO_ACCOUNT", "NOT_STARTED", "PENDING", "REJECTED", "RESTRICTED", "RESTRICTED_SOON", "STARTED" ], "type": "string" }, "StripeAccount": { "properties": { "accountId": { "type": "string" }, "canDelete": { "type": "boolean" }, "capabilities": { "type": "string" }, "cashPaymentAppId": { "type": "number", "format": "double" }, "country": { "type": "string", "x-nullable": true }, "currencyCode": { "type": "object" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "handleName": { "type": "string" }, "id": { "type": "number", "format": "double" }, "isActive": { "type": "boolean", "enum": [ true ], "x-nullable": false }, "name": { "type": "string" }, "note": { "type": "string" }, "onboardingStatus": { "$ref": "#/definitions/StripeOnboardingStatus" }, "updatedAt": { "type": "string" } }, "required": [ "accountId", "canDelete", "cashPaymentAppId", "createdAt", "globalUserId", "handleName", "id", "isActive", "onboardingStatus", "updatedAt" ], "type": "object", "additionalProperties": false }, "GetInfluencerBrandsResponse": { "items": { "$ref": "#/definitions/Brand" }, "type": "array" }, "InfluencerStatusDto": { "properties": { "publicLabel": { "type": "string" }, "instructions": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "publicLabel", "instructions", "id" ], "type": "object" }, "DataResponse_InfluencerStatusDto_": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerStatusDto" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "InfluencerStatusListDto": { "$ref": "#/definitions/DataResponse_InfluencerStatusDto_" }, "ReportInfluencerStatusRequestBody": { "properties": { "comment": { "type": "string" }, "statusId": { "type": "number", "format": "double" } }, "required": [ "statusId" ], "type": "object" }, "Record_ExternalPlatform.boolean_": { "properties": { "mavely": { "type": "boolean" } }, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "ConflictError": { "properties": { "message": { "type": "string", "enum": [ "Conflict" ], "x-nullable": false }, "httpStatusCode": { "type": "number", "format": "double" }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "httpStatusCode", "details" ], "type": "object", "additionalProperties": false }, "ExternalPlatform": { "enum": [ "mavely" ], "type": "string" }, "Record_string.any_": { "properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "ExternalPlatformConnection": { "properties": { "data": { "$ref": "#/definitions/Record_string.any_" }, "platformId": { "type": "string" }, "platform": { "$ref": "#/definitions/ExternalPlatform" } }, "required": [ "data", "platformId", "platform" ], "type": "object" }, "ExternalPlatformConnectionMap": { "properties": { "mavely": { "$ref": "#/definitions/ExternalPlatformConnection" } }, "type": "object" }, "Spec": { "properties": { "id": { "type": "number", "format": "double" }, "title": { "type": "string" }, "destinationUrl": { "type": "string" }, "laterInfluenceCampaignId": { "type": "number", "format": "double" }, "provider": { "type": "string" }, "isDeleted": { "type": "boolean" }, "deletedAt": { "type": "string", "x-nullable": true } }, "required": [ "id", "title", "destinationUrl", "laterInfluenceCampaignId", "provider", "isDeleted", "deletedAt" ], "type": "object", "additionalProperties": false }, "LinkMetrics": { "properties": { "clicksCount": { "type": "number", "format": "double" }, "salesCount": { "type": "number", "format": "double" }, "sales": { "type": "string" }, "conversion": { "type": "string" }, "commission": { "type": "string" } }, "required": [ "clicksCount", "salesCount", "sales", "conversion", "commission" ], "type": "object", "additionalProperties": false }, "CommissionDetails": { "properties": { "title": { "type": "string" }, "baseCommissionDetail": { "properties": { "baseCommissionType": { "type": "string" }, "title": { "type": "string" }, "id": { "type": "string" } }, "required": [ "title", "id" ], "type": "object" }, "commissionRules": { "items": { "properties": { "terms": { "type": "string" }, "commissionType": { "type": "string" }, "commissionRate": { "type": "number", "format": "double" } }, "required": [ "commissionType", "commissionRate" ], "type": "object" }, "type": "array" } }, "required": [ "title", "baseCommissionDetail", "commissionRules" ], "type": "object", "additionalProperties": false }, "MavelyBrandURLDetails": { "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "maxCommission": { "properties": { "maxFlat": { "type": "number", "format": "double" }, "maxRate": { "type": "number", "format": "double" } }, "required": [ "maxFlat", "maxRate" ], "type": "object" }, "termsText": { "type": "string" }, "termsUrl": { "type": "string" }, "commissionDetails": { "items": { "$ref": "#/definitions/CommissionDetails" }, "type": "array" }, "commissionFlatFloat": { "type": "number", "format": "double" }, "commissionRateFloat": { "type": "number", "format": "double" } }, "required": [ "id", "name", "maxCommission", "commissionDetails" ], "type": "object", "additionalProperties": false }, "Nullable_MavelyURLMetadataBase_": { "properties": { "description": { "type": "string", "x-nullable": true }, "publisher": { "type": "string", "x-nullable": true }, "lang": { "type": "string", "x-nullable": true }, "author": { "type": "string", "x-nullable": true }, "title": { "type": "string", "x-nullable": true }, "logo": { "type": "string", "x-nullable": true }, "url": { "type": "string", "x-nullable": true }, "favicon": { "type": "string", "x-nullable": true }, "site_name": { "type": "string", "x-nullable": true }, "image": { "type": "string", "x-nullable": true }, "images": { "items": { "type": "string" }, "type": "array", "x-nullable": true } }, "required": [ "description", "publisher", "lang", "logo", "url", "favicon", "site_name", "image", "images" ], "type": "object" }, "MavelyURLMetadata": { "$ref": "#/definitions/Nullable_MavelyURLMetadataBase_" }, "MavelyURLData": { "properties": { "details": { "type": "object" }, "metadata": { "type": "object" } }, "type": "object", "additionalProperties": false }, "CreateLinkFailedReason": { "properties": { "errorType": { "type": "string", "enum": [ "mavely:create:link", "mavely:create:campaign", "mavely:token:expired", "cds:token:notFound" ], "x-nullable": false }, "errorMessage": { "type": "string" } }, "required": [ "errorType", "errorMessage" ], "type": "object", "additionalProperties": false }, "Link": { "properties": { "id": { "type": "number", "format": "double" }, "link": { "type": "string" }, "laterInfluenceCampaignId": { "type": "number", "format": "double" }, "destinationUrl": { "type": "string" }, "title": { "type": "string" }, "provider": { "type": "string" }, "isDeleted": { "type": "boolean" }, "deletedAt": { "type": "string", "x-nullable": true }, "spec": { "$ref": "#/definitions/Spec" }, "metrics": { "$ref": "#/definitions/LinkMetrics" }, "urlData": { "$ref": "#/definitions/MavelyURLData" }, "failedReason": { "type": "object" } }, "required": [ "id", "link", "laterInfluenceCampaignId", "destinationUrl", "title", "provider", "isDeleted", "deletedAt" ], "type": "object", "additionalProperties": false }, "AffiliateServiceMetricsData": { "properties": { "conversionValue": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" } }, "required": [ "conversionValue", "conversions", "clicks" ], "type": "object" }, "AffiliateServiceAssignedProviderTracker": { "properties": { "archivedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "isArchived": { "type": "boolean" }, "destinationUrl": { "type": "string" }, "data": { "$ref": "#/definitions/AffiliateServiceMetricsData" }, "title": { "type": "string" }, "providerName": { "type": "string" }, "providerCode": { "type": "string" }, "url": { "type": "string" }, "parentId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" } }, "required": [ "archivedAt", "isArchived", "title", "providerName", "providerCode", "url", "id" ], "type": "object" }, "LaterInfluencerLinks": { "properties": { "trackingLinks": { "items": { "$ref": "#/definitions/AffiliateServiceAssignedProviderTracker" }, "type": "array" }, "affiliateLinks": { "items": { "$ref": "#/definitions/Link" }, "type": "array" } }, "required": [ "trackingLinks", "affiliateLinks" ], "type": "object" }, "LaterInfluencerSurveyQuestion": { "properties": { "type": { "type": "string" }, "setElements": { "items": { "properties": { "markUpDisplayLabel": { "type": "string", "x-nullable": true }, "displayLabel": { "type": "string" }, "key": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "displayLabel", "key", "id" ], "type": "object" }, "type": "array" }, "required": { "type": "boolean" }, "order": { "type": "number", "format": "double" }, "name": { "type": "string" }, "multi": { "type": "boolean" }, "key": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "markUpDescription": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "archived": { "type": "boolean" } }, "required": [ "type", "required", "order", "name", "multi", "key", "id", "description", "archived" ], "type": "object" }, "SurveyRouting": { "properties": { "text": { "type": "string" }, "url": { "type": "string" } }, "required": [ "text", "url" ], "type": "object" }, "SurveyStatus": { "type": "string", "enum": [ "ENDED", "COMPLETED", "PAUSED", "PENDING", "LIVE" ], "x-nullable": false }, "LaterInfluencerSurveyDto": { "properties": { "title": { "type": "string" }, "status": { "$ref": "#/definitions/SurveyStatus" }, "routing": { "$ref": "#/definitions/SurveyRouting" }, "questions": { "items": { "$ref": "#/definitions/LaterInfluencerSurveyQuestion" }, "type": "array" }, "imageUrl": { "type": "string" }, "description": { "type": "string" }, "communityId": { "type": "string" }, "brand": { "$ref": "#/definitions/Brand" } }, "required": [ "title", "status", "questions", "communityId", "brand" ], "type": "object" }, "QuestionAnswers": { "properties": {}, "additionalProperties": { "type": "object" }, "type": "object" }, "ActionGroupConversationTemplatePostResponse": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplatePostBody": { "properties": { "deliveryMethod": { "type": "string", "enum": [ "manual", "automatic" ], "x-nullable": false }, "disabled": { "type": "boolean" }, "html": { "type": "string" }, "order": { "type": "number", "format": "double" }, "version": { "type": "number", "format": "double" }, "sendOnDate": { "type": "string", "format": "date-time", "x-nullable": true }, "sendOnDays": { "type": "number", "format": "double", "x-nullable": true }, "sendOnEvent": { "type": "string", "enum": [ "due_date", "draft_due_date", "status_entry", "specific_date", "draft_needs_revision", "concept_due_date", "concept_needs_revision", null ], "x-nullable": true }, "sendOnStatusId": { "type": "number", "format": "double", "x-nullable": true }, "sendOnTimeframe": { "type": "string", "enum": [ "before", "after", null ], "x-nullable": true }, "slug": { "type": "string" }, "subject": { "type": "string" }, "title": { "type": "string" } }, "required": [ "html", "subject", "title" ], "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplate": { "properties": { "createdAt": { "type": "string", "format": "date-time" }, "createdByAccountId": { "type": "number", "format": "double" }, "deliveryMethod": { "type": "string", "enum": [ "manual", "automatic" ], "x-nullable": false }, "disabled": { "type": "boolean" }, "html": { "type": "string" }, "id": { "type": "number", "format": "double" }, "lastModifiedByAccountId": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "order": { "type": "number", "format": "double" }, "version": { "type": "number", "format": "double" }, "sendOnDate": { "type": "string", "format": "date-time", "x-nullable": true }, "sendOnDays": { "type": "number", "format": "double", "x-nullable": true }, "sendOnEvent": { "type": "string", "enum": [ "due_date", "draft_due_date", "status_entry", "specific_date", "draft_needs_revision", "concept_due_date", "concept_needs_revision", null ], "x-nullable": true }, "sendOnStatusId": { "type": "number", "format": "double", "x-nullable": true }, "sendOnTimeframe": { "type": "string", "enum": [ "before", "after", null ], "x-nullable": true }, "slug": { "type": "string" }, "subject": { "type": "string" }, "title": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "lastModifiedBy": { "$ref": "#/definitions/Administrator" }, "createdBy": { "$ref": "#/definitions/Administrator" }, "ListCustomStatus": { "additionalProperties": true }, "ActionGroup": { "additionalProperties": false, "type": "object" } }, "required": [ "html", "id", "listId", "subject", "title" ], "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplateCopyPostResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActionGroupConversationTemplate" }, "type": "array" }, "copy": { "$ref": "#/definitions/ActionGroupConversationTemplate" } }, "required": [ "data", "copy" ], "type": "object" }, "ActionGroupConversationTemplateCopyPostBody": { "properties": { "deliveryMethod": { "type": "string", "enum": [ "manual", "automatic" ], "x-nullable": false } }, "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplatesGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActionGroupConversationTemplate" }, "type": "array" }, "defaultTemplates": { "items": { "$ref": "#/definitions/ActionGroupConversationTemplatePostBody" }, "type": "array" } }, "required": [ "defaultTemplates" ], "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplatePutBody": { "properties": { "deliveryMethod": { "type": "string", "enum": [ "manual", "automatic" ], "x-nullable": false }, "disabled": { "type": "boolean" }, "html": { "type": "string" }, "sendOnDate": { "type": "string", "format": "date-time", "x-nullable": true }, "sendOnDays": { "type": "number", "format": "double", "x-nullable": true }, "sendOnEvent": { "type": "string", "enum": [ "due_date", "draft_due_date", "status_entry", "specific_date", "draft_needs_revision", "concept_due_date", "concept_needs_revision", null ], "x-nullable": true }, "sendOnStatusId": { "type": "number", "format": "double", "x-nullable": true }, "order": { "type": "number", "format": "double", "x-nullable": true }, "version": { "type": "number", "format": "double", "x-nullable": true }, "sendOnTimeframe": { "type": "string", "enum": [ "before", "after", null ], "x-nullable": true }, "slug": { "type": "string", "x-nullable": true }, "subject": { "type": "string" }, "title": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplateReorderPutResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActionGroupConversationTemplate" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "ActionGroupConversationTemplateReorderPutBody": { "properties": { "data": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ActionGroupSubscriber": { "properties": { "email": { "type": "string" }, "accountId": { "type": "number", "format": "double" } }, "required": [ "email", "accountId" ], "type": "object" }, "EmailSmtp": { "properties": { "email": { "type": "string" }, "name": { "type": "string" } }, "required": [ "email", "name" ], "type": "object" }, "SubscriberSettings": { "properties": { "emailSmtp": { "$ref": "#/definitions/EmailSmtp" }, "subscribers": { "items": { "$ref": "#/definitions/ActionGroupSubscriber" }, "type": "array" } }, "required": [ "emailSmtp", "subscribers" ], "type": "object" }, "QueryActionGroupParticipantMetadata": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "offset", "limit", "totalCount" ], "type": "object" }, "ActionGroupParticipantApplicationResponseDto": { "properties": { "value": { "type": "string" }, "key": { "type": "string" } }, "required": [ "value", "key" ], "type": "object" }, "ActionGroupParticipantAssessmentDto": { "properties": { "createdAt": { "type": "string", "format": "date-time" }, "assessorName": { "type": "string" }, "assessorEmail": { "type": "string" }, "approves": { "type": "boolean" } }, "required": [ "createdAt", "approves" ], "type": "object" }, "ActionGroupParticipantPinnedCommentAuthorDto": { "properties": { "image": { "type": "string" }, "last_name": { "type": "string" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object" }, "ActionGroupParticipantPinnedCommentDto": { "properties": { "author": { "$ref": "#/definitions/ActionGroupParticipantPinnedCommentAuthorDto" }, "createdAt": { "type": "string", "format": "date-time" }, "text": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "author", "text", "id" ], "type": "object" }, "ActionGroupParticipantCustomStatusDto": { "properties": { "custom": { "type": "boolean" }, "linkedStages": { "items": { "type": "string" }, "type": "array" }, "statusOrder": { "type": "number", "format": "double" }, "slug": { "type": "string" }, "phase": { "type": "string" }, "label": { "type": "string" }, "id": { "type": "number", "format": "double" }, "disabled": { "type": "boolean" }, "ctaLabel": { "type": "string" }, "auxiliaryLabel": { "type": "string" } }, "required": [ "custom", "linkedStages", "slug", "label", "id" ], "type": "object" }, "ActionGroupParticipantInstagramPostDto": { "properties": { "link": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "link", "imageUrl" ], "type": "object" }, "ActionGroupParticipantTiktokPostDto": { "properties": { "link": { "type": "string" }, "imageUrl": { "type": "string" } }, "required": [ "link", "imageUrl" ], "type": "object" }, "ActionGroupParticipantCostAndPerformanceDto": { "properties": { "value": { "type": "number", "format": "double" }, "rewards": { "type": "number", "format": "double" }, "posts": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "conversionValue": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" } }, "required": [ "value", "rewards", "posts", "listMemberId", "impressions", "engagements", "cost", "conversionValue", "conversions", "clicks" ], "type": "object" }, "ActionGroupParticipantTopicDto": { "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "slug", "name", "id" ], "type": "object" }, "ActionGroupParticipantContactInfoDto": { "properties": { "zip": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "phone": { "type": "string" }, "lastName": { "type": "string" }, "genderDescription": { "type": "string" }, "gender": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "email": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "apt": { "type": "string" }, "emailIsVerified": { "type": "boolean" } }, "required": [ "zip", "street", "state", "phone", "lastName", "genderDescription", "gender", "fullName", "firstName" ], "type": "object" }, "ActionGroupParticipantMembershipDto": { "properties": { "contactInfo": { "$ref": "#/definitions/ActionGroupParticipantContactInfoDto" }, "updatedAt": { "type": "string", "format": "date-time" }, "totalImpressions": { "type": "number", "format": "double" }, "status": { "type": "string" }, "mostRecentActivationDate": { "type": "string", "format": "date-time" }, "membershipType": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "lifetimeConversionsValue": { "type": "number", "format": "double" }, "lifetimeConversions": { "type": "number", "format": "double" }, "lifetimeClicks": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "blacklisted": { "type": "boolean" } }, "required": [ "contactInfo", "updatedAt", "status", "membershipType", "membershipId", "lifetimeConversionsValue", "lifetimeConversions", "lifetimeClicks", "id", "createdAt", "blacklisted" ], "type": "object" }, "ActionGroupParticipantFacebookProfileDto": { "properties": { "type": { "type": "string", "enum": [ "account", "page" ], "x-nullable": false }, "averageLikes": { "type": "number", "format": "double" }, "picture": { "type": "string" }, "name": { "type": "string" }, "facebookExternalId": { "type": "string" } }, "required": [ "type", "facebookExternalId" ], "type": "object" }, "ActionGroupParticipantInstagramProfileDto": { "properties": { "profileType": { "type": "string", "enum": [ "platform", "business" ], "x-nullable": false }, "profilePicture": { "type": "string" }, "mediaCount": { "type": "number", "format": "double" }, "isPrivate": { "type": "boolean" }, "isBusiness": { "type": "boolean" }, "handle": { "type": "string" }, "fullName": { "type": "string" }, "followingCount": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "averageLikes": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "averageComments": { "type": "number", "format": "double" } }, "type": "object" }, "ActionGroupParticipantTiktokProfileDto": { "properties": { "status": { "type": "string", "enum": [ "IN", "INVALID", "INVITED", "NOT_IN" ], "x-nullable": false }, "profileImage": { "type": "string" }, "isActive": { "type": "boolean" }, "handleName": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "displayName": { "type": "string" } }, "type": "object" }, "ActionGroupParticipantUserDto": { "properties": { "tiktokCreator": { "$ref": "#/definitions/ActionGroupParticipantTiktokProfileDto" }, "instagramAccount": { "$ref": "#/definitions/ActionGroupParticipantInstagramProfileDto" }, "facebookProfile": { "$ref": "#/definitions/ActionGroupParticipantFacebookProfileDto" }, "appMembership": { "$ref": "#/definitions/ActionGroupParticipantMembershipDto" }, "influencerTopics": { "items": { "$ref": "#/definitions/ActionGroupParticipantTopicDto" }, "type": "array" }, "state": { "type": "string" }, "id": { "type": "number", "format": "double" }, "gender": { "type": "string" }, "fullName": { "type": "string" }, "email": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "birthday": { "type": "string" }, "audiencePredominantCountry": { "type": "string" }, "audiencePredominantCity": { "type": "string" }, "audiencePredominantAgeRange": { "type": "string" }, "audiencePercentageFemale": { "type": "number", "format": "double" }, "audiencePercentage_65_plus": { "type": "number", "format": "double" }, "audiencePercentage_55_64": { "type": "number", "format": "double" }, "audiencePercentage_45_54": { "type": "number", "format": "double" }, "audiencePercentage_35_44": { "type": "number", "format": "double" }, "audiencePercentage_25_34": { "type": "number", "format": "double" }, "audiencePercentage_18_24": { "type": "number", "format": "double" }, "audiencePercentage_13_17": { "type": "number", "format": "double" }, "age": { "type": "number", "format": "double" } }, "required": [ "appMembership", "influencerTopics", "id", "email" ], "type": "object" }, "ActionGroupParticipantDto": { "properties": { "user": { "$ref": "#/definitions/ActionGroupParticipantUserDto" }, "upvotes": { "type": "number", "format": "double" }, "totalVotes": { "type": "number", "format": "double" }, "statusId": { "type": "number", "format": "double" }, "participating": { "type": "boolean" }, "optedIn": { "type": "boolean" }, "netVotes": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "listMemberCostAndPerformance": { "$ref": "#/definitions/ActionGroupParticipantCostAndPerformanceDto" }, "tiktokPosts": { "items": { "$ref": "#/definitions/ActionGroupParticipantTiktokPostDto" }, "type": "array" }, "instagramPosts": { "items": { "$ref": "#/definitions/ActionGroupParticipantInstagramPostDto" }, "type": "array" }, "id": { "type": "number", "format": "double" }, "hasConversations": { "type": "boolean" }, "globalUserId": { "type": "number", "format": "double" }, "downvotes": { "type": "number", "format": "double" }, "customStatus": { "$ref": "#/definitions/ActionGroupParticipantCustomStatusDto" }, "completed": { "type": "boolean" }, "pinnedComment": { "type": "object" }, "commentsCount": { "type": "number", "format": "double" }, "assessments": { "items": { "$ref": "#/definitions/ActionGroupParticipantAssessmentDto" }, "type": "array" }, "applicationResponses": { "items": { "$ref": "#/definitions/ActionGroupParticipantApplicationResponseDto" }, "type": "array" } }, "required": [ "user", "upvotes", "totalVotes", "netVotes", "listMemberId", "listMemberCostAndPerformance", "tiktokPosts", "instagramPosts", "id", "hasConversations", "globalUserId", "downvotes", "customStatus", "assessments", "applicationResponses" ], "type": "object" }, "QueryActionGroupParticipantsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActionGroupParticipantDto" }, "type": "array" }, "meta": { "$ref": "#/definitions/QueryActionGroupParticipantMetadata" } }, "required": [ "data", "meta" ], "type": "object" }, "UpsertReviewFormBody": { "properties": { "productId": { "type": "number", "format": "double" }, "actionId": { "type": "string" } }, "required": [ "productId" ], "type": "object" }, "GetActionTeaserResponse": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "instructions": { "type": "string" }, "type": { "type": "string" }, "routing": { "$ref": "#/definitions/Routing" }, "brand": { "$ref": "#/definitions/Brand" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ActionGroupUpdateBriefPostResponse": { "properties": { "brief": { "type": "string" } }, "required": [ "brief" ], "type": "object" }, "ActionGroupPostResponse": { "properties": { "workflowStatuses": { "additionalProperties": true }, "title": { "type": "string" }, "requiredHashtag": { "type": "string" }, "numberOfInfluencers": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "internalDescription": { "type": "string" }, "ftcHashtag": { "type": "string" }, "createdAt": { "type": "string" }, "brief": { "type": "string" }, "activityBudget": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "actions": { "items": { "properties": { "type": { "type": "string" } }, "required": [ "type" ], "type": "object" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "Pick_ActionGroupPostBody.internalDescription-or-title_": { "properties": { "title": { "type": "string" }, "internalDescription": { "type": "string" } }, "required": [ "title" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "ActionGroupCopyPostBody": { "type": "object", "properties": {} }, "ActionGroupStatusMap": { "properties": {}, "type": "object", "additionalProperties": { "type": "string" } }, "ActionGroupStatusQueryRequest": { "properties": { "actionGroupIds": { "items": { "type": "integer", "format": "int32" }, "type": "array", "description": "Array of action group IDs to query (max 100)", "minItems": 1, "maxItems": 100 } }, "required": [ "actionGroupIds" ], "type": "object", "additionalProperties": false }, "ActionTeaserTS": { "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "instructions": { "type": "string" }, "type": { "type": "string" }, "routing": { "additionalProperties": true }, "brand": { "additionalProperties": true } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ActionGroupTeaser": { "properties": { "id": { "type": "number", "format": "double" }, "title": { "type": "string" }, "description": { "type": "string" }, "image": { "type": "string" }, "type": { "type": "string" }, "contentType": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "brand": { "additionalProperties": true }, "actions": { "items": { "$ref": "#/definitions/ActionTeaserTS" }, "type": "array" }, "termsOfServiceLink": { "type": "string" }, "listId": { "type": "number", "format": "double", "x-nullable": true }, "locale": { "type": "string" }, "networks": { "items": { "type": "string" }, "type": "array" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ActionGroupTeaserGetResponse": { "$ref": "#/definitions/ActionGroupTeaser" }, "ActivationQueryParams": { "properties": { "queryEnabled": { "type": "boolean", "x-nullable": true }, "actionGroupId": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true, "minItems": 1 }, "networks": { "items": { "type": "string" }, "type": "array", "x-nullable": true, "minItems": 1 }, "postDateBefore": { "type": "string", "format": "date", "x-nullable": true }, "postDateAfter": { "type": "string", "format": "date", "x-nullable": true }, "postsWithUGC": { "type": "boolean", "x-nullable": true }, "filterTagIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true }, "tagQuantifier": { "type": "string", "enum": [ "all", "any", null ], "x-nullable": true }, "userFilter": { "type": "string", "x-nullable": true, "minLength": 1 }, "approvalStatus": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "ActivationTagAssociationRequestBody": { "properties": { "tagIds": { "items": { "type": "number", "format": "double" }, "type": "array", "minItems": 1 }, "activationIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true, "minItems": 1 }, "excludeActivationIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true, "description": "A parameter to determine which activations to omit from the association." } }, "required": [ "tagIds" ], "type": "object", "additionalProperties": false }, "ActivationTagAssociationPostRequestBody": { "type": "object", "properties": { "queryEnabled": { "type": "boolean", "x-nullable": true }, "actionGroupId": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true }, "networks": { "items": { "type": "string" }, "type": "array", "x-nullable": true }, "postDateBefore": { "type": "string", "format": "date", "x-nullable": true }, "postDateAfter": { "type": "string", "format": "date", "x-nullable": true }, "postsWithUGC": { "type": "boolean", "x-nullable": true }, "filterTagIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true }, "tagQuantifier": { "type": "string", "enum": [ "all", "any", null ], "x-nullable": true }, "userFilter": { "type": "string", "x-nullable": true }, "approvalStatus": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true }, "tagIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "activationIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true }, "excludeActivationIds": { "items": { "type": "number", "format": "double" }, "type": "array", "x-nullable": true } } }, "ActivationTagAssociation": { "properties": { "tagId": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "activationId": { "type": "number", "format": "double" } }, "required": [ "tagId", "createdAt", "activationId" ], "type": "object" }, "ResponseBody__disassociations-ActivationTagAssociation-Array--disassociatedCount-number--__": { "properties": { "data": { "properties": { "disassociatedCount": { "type": "number", "format": "double" }, "disassociations": { "items": { "$ref": "#/definitions/ActivationTagAssociation" }, "type": "array" } }, "required": [ "disassociatedCount", "disassociations" ], "type": "object" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ActivationTagDisassociationDeleteResponse": { "$ref": "#/definitions/ResponseBody__disassociations-ActivationTagAssociation-Array--disassociatedCount-number--__" }, "PostActivationsRequestBody": { "properties": { "audienceAgeDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceAgeDistribution" }, "type": "array", "x-nullable": true }, "audienceCountriesDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceCountriesDistribution" }, "type": "array", "x-nullable": true }, "audienceGendersDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceGendersDistribution" }, "type": "array", "x-nullable": true }, "audienceInterestDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceInterestDistribution" }, "type": "array", "x-nullable": true }, "caption": { "type": "string" }, "clicks": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "commentsOrganic": { "type": "number", "format": "double" }, "commentsPaid": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "externalId": { "type": "string" }, "engagementCount": { "type": "number", "format": "double" }, "image": { "type": "string" }, "impressions": { "type": "number", "format": "double" }, "impressionsSource": { "type": "string" }, "likes": { "type": "number", "format": "double" }, "likesOrganic": { "type": "number", "format": "double" }, "likesPaid": { "type": "number", "format": "double" }, "link": { "type": "string" }, "network": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "sharesOrganic": { "type": "number", "format": "double" }, "sharesPaid": { "type": "number", "format": "double" }, "video": { "type": "string" }, "videoCompletionRate": { "type": "number", "format": "double" }, "totalPlayTime": { "type": "number", "format": "double" }, "videoViewsBySource": { "items": { "$ref": "#/definitions/TikTokVideoViewsBySource" }, "type": "array", "x-nullable": true }, "videoViews": { "type": "number", "format": "double" }, "videoViewsOrganic": { "type": "number", "format": "double" }, "videoViewsPaid": { "type": "number", "format": "double" }, "followersAtPostDate": { "type": "number", "format": "double" } }, "required": [ "caption", "createdAt", "externalId", "link", "network" ], "type": "object", "additionalProperties": false }, "ActivationHistoryItem": { "properties": { "surveyResponses": { "type": "string" }, "profilePicture": { "type": "string" }, "posts": { "type": "number", "format": "double" }, "networkEngagements": { "type": "string" }, "network": { "type": "string" }, "membershipType": { "type": "string" }, "membershipStatus": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "joinDate": { "type": "string", "format": "date-time" }, "fullName": { "type": "string" }, "conversionsValue": { "type": "string" }, "conversions": { "type": "string" }, "contactZip": { "type": "string" }, "contactStreetLine2": { "type": "string" }, "contactStreet": { "type": "string" }, "contactState": { "type": "string" }, "contactLastName": { "type": "string" }, "contactFirstName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "contactCountry": { "type": "string" }, "contactCity": { "type": "string" }, "clicks": { "type": "string" }, "completionDate": { "type": "string", "format": "date-time" }, "campaignName": { "type": "string" }, "campaignId": { "type": "number", "format": "double" }, "audienceName": { "type": "string" }, "audienceId": { "type": "number", "format": "double" }, "actionType": { "type": "string" }, "actionTitle": { "type": "string" }, "actionId": { "type": "string" }, "actionGroupType": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" }, "actionGroupContentType": { "type": "string" }, "actionGroupActionMainType": { "type": "number", "format": "double" } }, "type": "object" }, "ResponseBody_ActivationHistoryItem-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/ActivationHistoryItem" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "InfluencerIncentiveDetails": { "properties": { "paidAmount": { "type": "number", "format": "double" }, "readyAmount": { "type": "number", "format": "double" }, "committedAmount": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" } }, "required": [ "paidAmount", "readyAmount", "committedAmount", "listMemberId" ], "type": "object" }, "InfluencerIncentiveDetailsResponse": { "type": "object", "properties": {} }, "EnrichedCampaignData": { "properties": { "instanceId": { "type": "string" }, "status": { "type": "string" }, "internalDescription": { "type": "string" }, "contentDueDate": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "title": { "type": "string" }, "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" }, "campaignId": { "type": "number", "format": "double" } }, "required": [ "campaignId" ], "type": "object" }, "EnrichedCampaignsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/EnrichedCampaignData" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "CreatorProfile": { "properties": { "network": { "type": "string" }, "handleName": { "type": "string" }, "profileLink": { "type": "string" }, "profileImage": { "type": "string" }, "fullName": { "type": "string" } }, "required": [ "network", "handleName", "profileLink", "profileImage" ], "type": "object", "additionalProperties": false }, "TopPerformer": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "profilePictureUrl": { "type": "string" }, "fullName": { "type": "string" }, "profiles": { "items": { "$ref": "#/definitions/CreatorProfile" }, "type": "array" } }, "required": [ "globalUserId", "profilePictureUrl", "fullName", "profiles" ], "type": "object", "additionalProperties": false }, "EnrichedCreatorsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/TopPerformer" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "EnrichedCreatorsResponseV3": { "properties": { "data": { "items": { "$ref": "#/definitions/TopPerformer" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ContentExternalIdentity": { "properties": { "alternativeIds": { "items": { "$ref": "#/definitions/ContentExternalIdentity" }, "type": "array" }, "type": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "ContentProfile": { "properties": { "dateCreated": { "type": "number", "format": "double" }, "contentCount": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "monthlyViewers": { "type": "number", "format": "double" }, "followingCount": { "type": "number", "format": "double" }, "followersCount": { "type": "number", "format": "double" }, "type": { "type": "string" }, "website": { "type": "string" }, "url": { "type": "string" }, "biography": { "type": "string" }, "picture": { "type": "string" }, "username": { "type": "string" }, "platform": { "type": "string" }, "externalId": { "$ref": "#/definitions/ContentExternalIdentity" } }, "required": [ "platform", "externalId" ], "type": "object" }, "ContentEngagements": { "properties": { "avgWatchTime": { "type": "number", "format": "double" }, "videoCompletionRate": { "type": "number", "format": "double" }, "videoViewTotalTime": { "type": "number", "format": "double" }, "followersAtPostDate": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "reach": { "type": "number", "format": "double" }, "videoViews": { "type": "number", "format": "double" }, "viewsPaid": { "type": "number", "format": "double" }, "viewsOrganic": { "type": "number", "format": "double" }, "views": { "type": "number", "format": "double" }, "swipeUps": { "type": "number", "format": "double" }, "replies": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "retweets": { "type": "number", "format": "double" }, "saves": { "type": "number", "format": "double" }, "sharesPaid": { "type": "number", "format": "double" }, "sharesOrganic": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "commentsPaid": { "type": "number", "format": "double" }, "commentsOrganic": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "favorites": { "type": "number", "format": "double" }, "closeUps": { "type": "number", "format": "double" }, "likesPaid": { "type": "number", "format": "double" }, "likesOrganic": { "type": "number", "format": "double" }, "likes": { "type": "number", "format": "double" }, "hearts": { "type": "number", "format": "double" }, "audienceInterestDistribution": { "items": { "additionalProperties": true }, "type": "array", "x-nullable": true }, "audienceGendersDistribution": { "items": { "additionalProperties": true }, "type": "array", "x-nullable": true }, "audienceCountriesDistribution": { "items": { "additionalProperties": true }, "type": "array", "x-nullable": true }, "audienceAgeDistribution": { "items": { "additionalProperties": true }, "type": "array", "x-nullable": true } }, "type": "object" }, "ContentMediaSize": { "properties": { "unit": { "type": "string", "enum": [ "CENTIMETERS", "MILLIMETERS", "INCHES", "PIXELS", "PERCENT", "POINTS" ], "x-nullable": false }, "height": { "type": "number", "format": "double" }, "width": { "type": "number", "format": "double" } }, "required": [ "unit" ], "type": "object" }, "ContentMedia": { "properties": { "videos": { "items": { "properties": { "duration": { "type": "number", "format": "double" }, "size": { "$ref": "#/definitions/ContentMediaSize" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" }, "type": "array" }, "images": { "items": { "properties": { "size": { "$ref": "#/definitions/ContentMediaSize" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" }, "type": "array" } }, "type": "object" }, "ContentInfo": { "properties": { "dateCreated": { "type": "number", "format": "double" }, "urlCanonical": { "type": "string" }, "url": { "type": "string" }, "text": { "type": "string" }, "media": { "$ref": "#/definitions/ContentMedia" }, "engagements": { "$ref": "#/definitions/ContentEngagements" }, "status": { "type": "string", "enum": [ "DRAFT", "PUBLISHED" ], "x-nullable": false }, "type": { "type": "string" }, "profile": { "type": "object" }, "externalId": { "$ref": "#/definitions/ContentExternalIdentity" } }, "required": [ "media", "type", "profile" ], "type": "object" }, "EnrichedContentData": { "properties": { "network": { "$ref": "#/definitions/ActivationContentNetwork" }, "content": { "$ref": "#/definitions/ContentInfo" }, "activationId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "network", "content", "activationId", "globalUserId" ], "type": "object" }, "EnrichedContentResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/EnrichedContentData" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "BackfillAnalyticsDataEntryPointJobPayload": { "properties": { "delayBetweenAnalyticsServiceRequests": { "type": "number", "format": "double" }, "activationIdsPerAnalyticsServiceRequest": { "type": "number", "format": "double" }, "activationIdsPerJob": { "type": "number", "format": "double" }, "activationIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "actionGroupIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "communityIds": { "items": { "type": "string" }, "type": "array" }, "periodEnd": { "type": "string" }, "periodStart": { "type": "string" } }, "type": "object" }, "BackfillAnalyticsCostDataJobPayload": { "properties": { "preferedChunkSize": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "actionGroupIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "communityIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "ContentReport": { "properties": { "dateGroup": { "type": "string" }, "year": { "type": "number", "format": "double" }, "quarter": { "type": "number", "format": "double" }, "month": { "type": "number", "format": "double" }, "day": { "type": "number", "format": "double" }, "content": { "type": "number", "format": "double" }, "content_activated_members": { "type": "number", "format": "double" }, "likes": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "content_reach": { "type": "number", "format": "double" }, "facebook_engagements": { "type": "number", "format": "double" }, "facebook_post_engagements": { "type": "number", "format": "double" }, "facebook_live_engagements": { "type": "number", "format": "double" }, "facebook_reel_engagements": { "type": "number", "format": "double" }, "instagram_engagements": { "type": "number", "format": "double" }, "instagram_post_engagements": { "type": "number", "format": "double" }, "instagram_story_engagements": { "type": "number", "format": "double" }, "instagram_reel_engagements": { "type": "number", "format": "double" }, "twitter_engagements": { "type": "number", "format": "double" }, "pinterest_engagements": { "type": "number", "format": "double" }, "blog_engagements": { "type": "number", "format": "double" }, "youtube_engagements": { "type": "number", "format": "double" }, "youtube_shorts_engagements": { "type": "number", "format": "double" }, "snapchat_engagements": { "type": "number", "format": "double" }, "tiktok_engagements": { "type": "number", "format": "double" }, "twitch_streams_engagements": { "type": "number", "format": "double" }, "linkedin_engagements": { "type": "number", "format": "double" }, "facebook_impressions": { "type": "number", "format": "double" }, "facebook_post_impressions": { "type": "number", "format": "double" }, "facebook_live_impressions": { "type": "number", "format": "double" }, "facebook_reel_impressions": { "type": "number", "format": "double" }, "instagram_impressions": { "type": "number", "format": "double" }, "instagram_post_impressions": { "type": "number", "format": "double" }, "instagram_story_impressions": { "type": "number", "format": "double" }, "instagram_reel_impressions": { "type": "number", "format": "double" }, "twitter_impressions": { "type": "number", "format": "double" }, "pinterest_impressions": { "type": "number", "format": "double" }, "blog_impressions": { "type": "number", "format": "double" }, "youtube_impressions": { "type": "number", "format": "double" }, "youtube_shorts_impressions": { "type": "number", "format": "double" }, "snapchat_impressions": { "type": "number", "format": "double" }, "tiktok_impressions": { "type": "number", "format": "double" }, "twitch_streams_impressions": { "type": "number", "format": "double" }, "linkedin_impressions": { "type": "number", "format": "double" }, "facebook_content": { "type": "number", "format": "double" }, "facebook_post_content": { "type": "number", "format": "double" }, "facebook_live_content": { "type": "number", "format": "double" }, "facebook_reel_content": { "type": "number", "format": "double" }, "instagram_content": { "type": "number", "format": "double" }, "instagram_post_content": { "type": "number", "format": "double" }, "instagram_story_content": { "type": "number", "format": "double" }, "instagram_reel_content": { "type": "number", "format": "double" }, "twitter_content": { "type": "number", "format": "double" }, "pinterest_content": { "type": "number", "format": "double" }, "blog_content": { "type": "number", "format": "double" }, "youtube_content": { "type": "number", "format": "double" }, "youtube_shorts_content": { "type": "number", "format": "double" }, "snapchat_content": { "type": "number", "format": "double" }, "tiktok_content": { "type": "number", "format": "double" }, "twitch_streams": { "type": "number", "format": "double" }, "linkedin_content": { "type": "number", "format": "double" }, "non_network_content": { "type": "number", "format": "double" }, "non_network_images_uploaded": { "type": "number", "format": "double" }, "non_network_videos_uploaded": { "type": "number", "format": "double" }, "pinterest_comments": { "type": "number", "format": "double" }, "pinterest_clicks": { "type": "number", "format": "double" }, "pinterest_saves": { "type": "number", "format": "double" }, "pinterest_verified_impressions": { "type": "number", "format": "double" }, "member_registrations": { "type": "number", "format": "double" }, "activations": { "type": "number", "format": "double" }, "activated_members": { "type": "number", "format": "double" }, "surveys": { "type": "number", "format": "double" }, "reviews": { "type": "number", "format": "double" }, "emv_value": { "type": "number", "format": "double", "x-nullable": true }, "networks": { "items": { "$ref": "#/definitions/ActivationContentNetwork" }, "type": "array" }, "clicks": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "conversions_value": { "type": "number", "format": "double" } }, "required": [ "dateGroup" ], "type": "object", "additionalProperties": false }, "ContentReportResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ContentReport" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "BackfillFollowersAtPostResponse": { "properties": { "message": { "type": "string" }, "processedBatches": { "type": "number", "format": "double" }, "updatedRecords": { "type": "number", "format": "double" } }, "required": [ "message", "processedBatches", "updatedRecords" ], "type": "object" }, "BackfillFollowersAtPostRequest": { "properties": { "batchSize": { "type": "number", "format": "double" }, "network": { "type": "string" }, "endDate": { "type": "string" }, "startDate": { "type": "string" } }, "required": [ "network", "endDate", "startDate" ], "type": "object" }, "UpdateContentActivationSummaryResponse": { "properties": { "message": { "type": "string" }, "errors": { "items": { "properties": { "error": { "type": "string" }, "activationId": { "type": "number", "format": "double" } }, "required": [ "error" ], "type": "object" }, "type": "array" }, "skippedEntities": { "type": "number", "format": "double" }, "processedEntities": { "type": "number", "format": "double" }, "updatedRecords": { "type": "number", "format": "double" } }, "required": [ "message", "errors", "skippedEntities", "processedEntities", "updatedRecords" ], "type": "object" }, "UpdateContentActivationSummaryEntity": { "properties": { "activationId": { "type": "number", "format": "double" } }, "additionalProperties": { "additionalProperties": true }, "required": [ "activationId" ], "type": "object" }, "UpdateContentActivationSummaryRequest": { "properties": { "entities": { "items": { "$ref": "#/definitions/UpdateContentActivationSummaryEntity" }, "type": "array" } }, "required": [ "entities" ], "type": "object" }, "ApplicationStates": { "properties": { "data": { "items": { "type": "string" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "BasicAuthPostResponse": { "properties": { "token": { "type": "string" }, "communityId": { "type": "string" } }, "required": [ "token", "communityId" ], "type": "object" }, "BasicAuthPostRequest": { "properties": { "password": { "type": "string" }, "email": { "type": "string" } }, "required": [ "password", "email" ], "type": "object" }, "FacebookAccessCodeExchangeRequest": { "properties": { "redirectUri": { "type": "string" }, "code": { "type": "string" } }, "required": [ "redirectUri", "code" ], "type": "object" }, "SwapAppPostResponse": { "properties": { "token": { "type": "string" } }, "required": [ "token" ], "type": "object", "additionalProperties": false }, "SwapAppRequestBody": { "properties": { "communityId": { "type": "string" } }, "required": [ "communityId" ], "type": "object", "additionalProperties": false }, "PendingBatchJob": { "properties": { "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "CREATED", "COMPLETED", "FAILED", "PROCESSING" ], "x-nullable": false } }, "required": [ "id", "name" ], "type": "object", "additionalProperties": false }, "GetPendingBatchJobsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/PendingBatchJob" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "WorkflowStatusRequirement": { "properties": { "type": { "type": "string", "enum": [ "promo_code" ], "x-nullable": false }, "satisfied": { "type": "boolean" } }, "required": [ "type", "satisfied" ], "type": "object" }, "BulkAssignCustomStatusesRequirementsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/WorkflowStatusRequirement" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "DBBazaarVoiceCommunityApp": { "properties": { "bazaarAppId": { "type": "number", "format": "double" }, "communityId": { "type": "string" } }, "required": [ "bazaarAppId", "communityId" ], "type": "object" }, "DBBazaarVoiceLocale": { "properties": { "country": { "type": "string" }, "language": { "type": "string" }, "code": { "type": "string" } }, "required": [ "country", "language", "code" ], "type": "object" }, "DBBazaarVoiceApp": { "properties": { "BazaarVoiceLocales": { "items": { "$ref": "#/definitions/DBBazaarVoiceLocale" }, "type": "array" }, "BazaarVoiceCommunityApps": { "items": { "$ref": "#/definitions/DBBazaarVoiceCommunityApp" }, "type": "array" }, "name": { "type": "string" }, "secret": { "type": "string" }, "environment": { "type": "string" }, "apiKey": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "name", "secret", "apiKey", "id" ], "type": "object" }, "BazaarVoiceAppResponse": { "$ref": "#/definitions/DBBazaarVoiceApp" }, "BazaarVoiceLocaleResponse": { "$ref": "#/definitions/DBBazaarVoiceLocale" }, "BazaarVoiceAppPostRequestBody": { "properties": { "locales": { "items": { "type": "string" }, "type": "array" }, "secret": { "type": "string" }, "name": { "type": "string" }, "environment": { "type": "string" }, "apiKey": { "type": "string" } }, "required": [ "locales", "secret", "name", "apiKey" ], "type": "object" }, "BazaarVoiceAppPostRequest": { "properties": { "data": { "$ref": "#/definitions/BazaarVoiceAppPostRequestBody" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "HarnessResponse_any.any_": { "properties": { "input": { "additionalProperties": true }, "output": { "additionalProperties": true } }, "required": [ "input", "output" ], "type": "object", "additionalProperties": false }, "SocialProfileInsights": { "description": "Later-generated predicted insights computed by the Insights Service and stored on the\nCDS social presence (`platformAttributes.prediction*`). The CDS client types these\nfor Instagram and TikTok today.", "properties": { "topics": { "items": { "properties": { "probability": { "type": "number", "format": "double" }, "topic": { "type": "string" } }, "required": [ "probability", "topic" ], "type": "object" }, "type": "array" }, "accountType": { "properties": { "probability": { "type": "number", "format": "double" }, "type": { "type": "string" } }, "required": [ "probability", "type" ], "type": "object", "x-nullable": true }, "primaryLanguage": { "properties": { "confidence": { "type": "number", "format": "double" }, "language": { "type": "string" } }, "required": [ "confidence", "language" ], "type": "object", "x-nullable": true }, "additionalLanguages": { "items": { "properties": { "proportion": { "type": "number", "format": "double" }, "language": { "type": "string" } }, "required": [ "proportion", "language" ], "type": "object" }, "type": "array", "description": "Other languages the content appears in, each with its share of that content." } }, "type": "object", "additionalProperties": false }, "SocialProfileInfo": { "properties": { "username": { "type": "string", "x-nullable": true }, "displayName": { "type": "string", "x-nullable": true }, "url": { "type": "string", "x-nullable": true }, "bio": { "type": "string", "x-nullable": true }, "followersCount": { "type": "number", "format": "double", "x-nullable": true }, "engagementRate": { "type": "number", "format": "double", "x-nullable": true }, "followingCount": { "type": "number", "format": "double", "x-nullable": true }, "mediaCount": { "type": "number", "format": "double", "x-nullable": true }, "insights": { "$ref": "#/definitions/SocialProfileInsights" } }, "required": [ "username", "displayName", "url", "bio" ], "type": "object", "additionalProperties": false }, "PartialCreatorProfile": { "properties": { "name": { "type": "string", "x-nullable": true }, "firstName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true }, "location": { "type": "string", "x-nullable": true }, "gender": { "type": "string", "x-nullable": true }, "age": { "type": "number", "format": "double", "x-nullable": true }, "socialProfiles": { "properties": { "blog": { "$ref": "#/definitions/SocialProfileInfo" }, "snapchat": { "$ref": "#/definitions/SocialProfileInfo" }, "facebook": { "$ref": "#/definitions/SocialProfileInfo" }, "pinterest": { "$ref": "#/definitions/SocialProfileInfo" }, "youtube": { "$ref": "#/definitions/SocialProfileInfo" }, "twitter": { "$ref": "#/definitions/SocialProfileInfo" }, "tiktok": { "$ref": "#/definitions/SocialProfileInfo" }, "instagram": { "$ref": "#/definitions/SocialProfileInfo" } }, "type": "object" } }, "required": [ "name", "firstName", "lastName", "location", "gender", "age", "socialProfiles" ], "type": "object", "additionalProperties": false }, "KnownSocialNetworkDTO": { "properties": { "platform": { "type": "string" }, "handle": { "type": "string" }, "url": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true } }, "required": [ "platform", "handle", "url", "description" ], "type": "object", "additionalProperties": false }, "CreatorContextDTO": { "properties": { "name": { "type": "string", "x-nullable": true }, "aliases": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string", "x-nullable": true }, "gender": { "type": "string", "x-nullable": true }, "industry": { "type": "string", "x-nullable": true }, "approximateAge": { "type": "number", "format": "double", "x-nullable": true }, "approximateLocation": { "type": "string", "x-nullable": true }, "knownSocialNetworks": { "items": { "$ref": "#/definitions/KnownSocialNetworkDTO" }, "type": "array" }, "dataSources": { "items": { "$ref": "#/definitions/DataSourceDTO" }, "type": "array" } }, "required": [ "name", "aliases", "description", "gender", "industry", "approximateAge", "approximateLocation", "knownSocialNetworks", "dataSources" ], "type": "object", "additionalProperties": false }, "SaveCreatorContextRequest": { "properties": { "input": { "$ref": "#/definitions/PartialCreatorProfile" }, "output": { "$ref": "#/definitions/CreatorContextDTO" } }, "type": "object", "additionalProperties": false }, "Partial_CreatorContextDTO_": { "properties": { "name": { "type": "string", "x-nullable": true }, "aliases": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string", "x-nullable": true }, "gender": { "type": "string", "x-nullable": true }, "industry": { "type": "string", "x-nullable": true }, "approximateAge": { "type": "number", "format": "double", "x-nullable": true }, "approximateLocation": { "type": "string", "x-nullable": true }, "knownSocialNetworks": { "items": { "$ref": "#/definitions/KnownSocialNetworkDTO" }, "type": "array" }, "dataSources": { "items": { "$ref": "#/definitions/DataSourceDTO" }, "type": "array" } }, "type": "object", "description": "Make all properties in T optional" }, "UpdateCreatorContextRequest": { "properties": { "patch": { "$ref": "#/definitions/Partial_CreatorContextDTO_" } }, "required": [ "patch" ], "type": "object", "additionalProperties": false }, "Record_string.unknown_": { "properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "MetricWeight": { "properties": { "weight": { "type": "number", "format": "double" }, "reason": { "type": "string" } }, "required": [ "weight", "reason" ], "type": "object", "additionalProperties": false }, "Record_AssessmentMetricsEnum.MetricWeight_": { "properties": { "brandAuthenticity": { "$ref": "#/definitions/MetricWeight" }, "controversyScandals": { "$ref": "#/definitions/MetricWeight" }, "adultContent": { "$ref": "#/definitions/MetricWeight" }, "vulgarityProfanity": { "$ref": "#/definitions/MetricWeight" }, "brandConflicts": { "$ref": "#/definitions/MetricWeight" }, "politicalContent": { "$ref": "#/definitions/MetricWeight" }, "socialClimate": { "$ref": "#/definitions/MetricWeight" }, "misinformation": { "$ref": "#/definitions/MetricWeight" }, "hateSpeech": { "$ref": "#/definitions/MetricWeight" }, "violenceContent": { "$ref": "#/definitions/MetricWeight" }, "substanceAbuse": { "$ref": "#/definitions/MetricWeight" }, "competitorConflicts": { "$ref": "#/definitions/MetricWeight" } }, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "MetricRelevanceWeights": { "$ref": "#/definitions/Record_AssessmentMetricsEnum.MetricWeight_" }, "BrandContextDTO": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "brandName": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "industry": { "type": "string", "x-nullable": true }, "targetAudience": { "type": "string", "x-nullable": true }, "brandValues": { "type": "string", "x-nullable": true }, "riskTolerance": { "$ref": "#/definitions/DataScoreLevelDTO" }, "potentialCompetitors": { "items": { "type": "string" }, "type": "array", "x-nullable": true }, "metricRelevanceWeights": { "$ref": "#/definitions/MetricRelevanceWeights" } }, "required": [ "dataConfidence", "brandName", "description", "industry", "targetAudience", "brandValues", "riskTolerance", "potentialCompetitors", "metricRelevanceWeights" ], "type": "object", "additionalProperties": false }, "SaveBrandContextRequest": { "properties": { "input": { "$ref": "#/definitions/Record_string.unknown_" }, "output": { "$ref": "#/definitions/BrandContextDTO" } }, "type": "object", "additionalProperties": false }, "Partial_BrandContextDTO_": { "properties": { "dataConfidence": { "$ref": "#/definitions/DataConfidenceDTO" }, "brandName": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "industry": { "type": "string", "x-nullable": true }, "targetAudience": { "type": "string", "x-nullable": true }, "brandValues": { "type": "string", "x-nullable": true }, "riskTolerance": { "$ref": "#/definitions/DataScoreLevelDTO" }, "potentialCompetitors": { "items": { "type": "string" }, "type": "array", "x-nullable": true }, "metricRelevanceWeights": { "$ref": "#/definitions/MetricRelevanceWeights" } }, "type": "object", "description": "Make all properties in T optional" }, "UpdateBrandContextRequest": { "properties": { "patch": { "$ref": "#/definitions/Partial_BrandContextDTO_" } }, "required": [ "patch" ], "type": "object", "additionalProperties": false }, "ResearchRequest": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "creatorContext": { "additionalProperties": false, "type": "object" } }, "type": "object", "additionalProperties": false }, "VerifySourcesRequest": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "creatorContext": { "additionalProperties": false, "type": "object" }, "sources": { "items": { "properties": { "credibility": { "type": "string", "enum": [ "high", "medium", "low" ], "x-nullable": false }, "sentiment": { "type": "string", "enum": [ "negative", "neutral", "positive" ], "x-nullable": false }, "sourceDate": { "type": "string", "x-nullable": true }, "keyQuotes": { "items": { "type": "string" }, "type": "array" }, "detailedSummary": { "type": "string" }, "url": { "type": "string" } }, "required": [ "url" ], "type": "object" }, "type": "array" } }, "required": [ "sources" ], "type": "object", "additionalProperties": false }, "ReverifyRequest": { "properties": { "creatorContext": { "additionalProperties": false, "type": "object" } }, "type": "object", "additionalProperties": false }, "AssessMetricRequest": { "properties": { "metric": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "creatorContext": { "additionalProperties": false, "type": "object" }, "findings": { "items": { "$ref": "#/definitions/StoredFinding" }, "type": "array" } }, "required": [ "metric" ], "type": "object", "additionalProperties": false }, "AssessFullRequest": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "campaignId": { "type": "number", "format": "double" }, "creatorContext": { "additionalProperties": false, "type": "object" }, "brandContext": { "additionalProperties": false, "type": "object" }, "campaignContext": { "additionalProperties": false, "type": "object" }, "findings": { "items": { "$ref": "#/definitions/StoredFinding" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "CreatorWithReports": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "latestReportDate": { "type": "string" }, "creatorName": { "type": "string" } }, "required": [ "globalUserId", "latestReportDate" ], "type": "object", "additionalProperties": false }, "GetCreatorsWithReportsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/CreatorWithReports" }, "type": "array" }, "meta": { "properties": { "hasMore": { "type": "boolean" } }, "required": [ "hasMore" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "BrandSuitabilityReportSummary": { "properties": { "totalScore": { "type": "number", "format": "double" }, "createdAt": { "type": "string" }, "status": { "$ref": "#/definitions/BrandSuitabilityReportStatus" }, "version": { "type": "string" }, "communityId": { "type": "string" }, "campaignId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "reportId": { "type": "string" } }, "required": [ "createdAt", "status", "version", "communityId", "campaignId", "globalUserId", "reportId" ], "type": "object" }, "GetReportsForCreatorResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/BrandSuitabilityReportSummary" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "GenerateReportResponse": { "properties": { "reportId": { "type": "string" }, "status": { "$ref": "#/definitions/BrandSuitabilityReportStatus" }, "data": { "$ref": "#/definitions/BrandSuitabilityReport" } }, "required": [ "reportId", "status" ], "type": "object", "additionalProperties": false }, "GenerateReportRequest": { "properties": { "campaignId": { "type": "number", "format": "double" }, "assessments": { "items": { "type": "string" }, "type": "array" }, "brandName": { "type": "string" } }, "type": "object", "additionalProperties": false }, "CreatorResearchRecord": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "findingsVersion": { "type": "string" }, "findings": { "items": { "$ref": "#/definitions/StoredFinding" }, "type": "array" }, "metadata": { "properties": { "researchModels": { "items": { "type": "string" }, "type": "array" }, "totalSourcesAnalyzed": { "type": "number", "format": "double" }, "queriesExecuted": { "items": { "type": "string" }, "type": "array" }, "researchDuration": { "type": "number", "format": "double" } }, "required": [ "researchModels", "totalSourcesAnalyzed", "queriesExecuted", "researchDuration" ], "type": "object" }, "version": { "type": "number", "format": "double" } }, "required": [ "globalUserId", "created_at", "updated_at", "findingsVersion", "findings", "metadata" ], "type": "object", "additionalProperties": false }, "FindingExclusion": { "properties": { "id": { "type": "string" }, "excluded": { "type": "boolean" } }, "required": [ "id", "excluded" ], "type": "object", "additionalProperties": false }, "UpdateFindingExclusionsRequest": { "properties": { "findings": { "items": { "$ref": "#/definitions/FindingExclusion" }, "type": "array" } }, "required": [ "findings" ], "type": "object", "additionalProperties": false }, "ReportStatsResponse": { "properties": { "totalReports": { "type": "number", "format": "double" }, "totalCreators": { "type": "number", "format": "double" }, "byStatus": { "properties": { "PROCESSING": { "type": "number", "format": "double" }, "FAILED": { "type": "number", "format": "double" }, "COMPLETED": { "type": "number", "format": "double" } }, "required": [ "PROCESSING", "FAILED", "COMPLETED" ], "type": "object" }, "byCampaign": { "items": { "properties": { "reportCount": { "type": "number", "format": "double" }, "campaignId": { "type": "string" } }, "required": [ "reportCount", "campaignId" ], "type": "object" }, "type": "array" }, "recentFailures": { "items": { "properties": { "createdAt": { "type": "string" }, "reason": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "reportId": { "type": "string" } }, "required": [ "createdAt", "reason", "globalUserId", "reportId" ], "type": "object" }, "type": "array" } }, "required": [ "totalReports", "totalCreators", "byStatus", "byCampaign", "recentFailures" ], "type": "object", "additionalProperties": false }, "DeleteReportResponse": { "properties": { "success": { "type": "boolean" }, "deletedReportId": { "type": "string" } }, "required": [ "success", "deletedReportId" ], "type": "object", "additionalProperties": false }, "BatchStatus": { "enum": [ "IN_PROGRESS", "COMPLETED", "PARTIAL_FAILURE", "FAILED" ], "type": "string" }, "CreateBatchResponse": { "properties": { "batchId": { "type": "string" }, "status": { "$ref": "#/definitions/BatchStatus" } }, "required": [ "batchId", "status" ], "type": "object", "additionalProperties": false }, "CreateBatchRequest": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "queryFilter": { "additionalProperties": true }, "actionGroupId": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" }, "brandName": { "type": "string" }, "assessments": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" } }, "type": "object", "additionalProperties": false }, "BatchListItem": { "properties": { "batchId": { "type": "string" }, "status": { "$ref": "#/definitions/BatchStatus" }, "label": { "type": "string" }, "communityName": { "type": "string" }, "campaignId": { "type": "number", "format": "double" }, "campaignTitle": { "type": "string" }, "brandName": { "type": "string" }, "total": { "type": "number", "format": "double" }, "completed": { "type": "number", "format": "double" }, "failed": { "type": "number", "format": "double" }, "skipped": { "type": "number", "format": "double" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "batchId", "status", "total", "completed", "failed", "skipped", "createdAt", "updatedAt" ], "type": "object", "additionalProperties": false }, "ListBatchesResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/BatchListItem" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "BatchSummaryCounts": { "properties": { "total": { "type": "number", "format": "double" }, "completed": { "type": "number", "format": "double" }, "failed": { "type": "number", "format": "double" }, "pending": { "type": "number", "format": "double" } }, "required": [ "total", "completed", "failed", "pending" ], "type": "object", "additionalProperties": false }, "BatchReportItem": { "properties": { "overallAssessment": { "type": "string" }, "metricRisks": { "items": { "$ref": "#/definitions/BatchMetricRisk" }, "type": "array" }, "failureReason": { "type": "string" }, "creatorName": { "type": "string" }, "dataConfidence": { "$ref": "#/definitions/DataScoreLevelDTO" }, "totalRiskScore": { "type": "number", "format": "double" }, "totalScore": { "type": "number", "format": "double" }, "progress": { "$ref": "#/definitions/BrandSuitabilityReportProgress" }, "status": { "$ref": "#/definitions/BrandSuitabilityReportStatus" }, "batchId": { "type": "string" }, "reportId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "status", "batchId", "reportId", "globalUserId" ], "type": "object", "additionalProperties": false }, "BatchDetailResponse": { "properties": { "batchId": { "type": "string" }, "status": { "$ref": "#/definitions/BatchStatus" }, "label": { "type": "string" }, "communityName": { "type": "string" }, "campaignId": { "type": "number", "format": "double" }, "campaignTitle": { "type": "string" }, "brandName": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "summary": { "$ref": "#/definitions/BatchSummaryCounts" }, "items": { "items": { "$ref": "#/definitions/BatchReportItem" }, "type": "array" } }, "required": [ "batchId", "status", "createdAt", "updatedAt", "summary", "items" ], "type": "object", "additionalProperties": false }, "AddCreatorsResponse": { "properties": { "batchId": { "type": "string" } }, "required": [ "batchId" ], "type": "object", "additionalProperties": false }, "AddCreatorsRequest": { "properties": { "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "globalUserIds" ], "type": "object", "additionalProperties": false }, "InstanceBrandListItem": { "properties": { "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "youtubeChannelId": { "type": "string", "x-nullable": true } }, "required": [ "id", "name", "youtubeChannelId" ], "type": "object", "additionalProperties": false }, "ActionGroupStatus": { "type": "string", "enum": [ "DRAFT", "READY", "PENDING", "LIVE", "PAUSED", "EXPIRED", "ARCHIVED" ], "x-nullable": false }, "ActionGroupBudgetCurrencyRollup": { "description": "Per-currency cost rollup for a single action group.", "properties": { "currencyCode": { "type": "string" }, "pendingCost": { "type": "number", "format": "double" }, "readyCost": { "type": "number", "format": "double" }, "fulfilledCost": { "type": "number", "format": "double" } }, "required": [ "currencyCode", "pendingCost", "readyCost", "fulfilledCost" ], "type": "object", "additionalProperties": false }, "ActionGroupBudget": { "properties": { "id": { "type": "number", "format": "double" }, "budget": { "type": "number", "format": "double", "x-nullable": true }, "pendingCost": { "type": "number", "format": "double" }, "pendingCount": { "type": "number", "format": "double" }, "readyCost": { "type": "number", "format": "double" }, "readyCount": { "type": "number", "format": "double" }, "fulfilledCost": { "type": "number", "format": "double" }, "fulfilledCount": { "type": "number", "format": "double" }, "balance": { "type": "object" }, "title": { "type": "object" }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "contentDueDate": { "type": "string", "x-nullable": true }, "status": { "$ref": "#/definitions/ActionGroupStatus" }, "costsByCurrency": { "items": { "$ref": "#/definitions/ActionGroupBudgetCurrencyRollup" }, "type": "array" } }, "required": [ "id", "pendingCost", "pendingCount", "readyCost", "readyCount", "fulfilledCost", "fulfilledCount", "status" ], "type": "object", "additionalProperties": false }, "ActionGroupBudgetsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ActionGroupBudget" }, "type": "array" }, "meta": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "DBRewardWinType": { "enum": [ "OTHER", "CASH", "PRODUCT", "PROMO_CODE", "GIFT_CARD", "SHOPIFY_DISCOUNT" ], "type": "string" }, "PaymentAppProvider": { "enum": [ "PAYPAL", "STRIPE", "TANGO_CARDS", "MAVELY", "TIPALTI" ], "type": "string" }, "FulfillmentStatus": { "enum": [ "REJECTED", "DRAFT", "PENDING", "READY" ], "type": "string" }, "InfluencerBudget": { "properties": { "campaignId": { "type": "number", "format": "double" }, "campaignName": { "type": "string" }, "campaignStatus": { "$ref": "#/definitions/ActionGroupStatus" }, "budget": { "type": "number", "format": "double" }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "influencerName": { "type": "string", "x-nullable": true }, "rewardWinType": { "$ref": "#/definitions/DBRewardWinType" }, "rewardWinCashPaymentAppProvider": { "type": "object" }, "fulfillmentStatus": { "type": "object" }, "cost": { "type": "number", "format": "double" } }, "required": [ "campaignId", "campaignName", "campaignStatus", "budget", "rewardWinType", "fulfillmentStatus", "cost" ], "type": "object", "additionalProperties": false }, "InfluencerBudgetsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerBudget" }, "type": "array" }, "meta": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "BudgetCurrencyAmount": { "properties": { "currencyCode": { "type": "string" }, "fundedAmount": { "type": "number", "format": "double" }, "spentAmount": { "type": "number", "format": "double" } }, "required": [ "currencyCode", "fundedAmount", "spentAmount" ], "type": "object", "additionalProperties": false }, "BudgetEntity": { "properties": { "id": { "type": "number", "format": "double" }, "budgetReferenceId": { "type": "string" }, "type": { "$ref": "#/definitions/BudgetReferenceIdType" }, "name": { "type": "string", "x-nullable": true }, "communityId": { "type": "string" }, "fundedAmount": { "type": "number", "format": "double" }, "spentAmount": { "type": "number", "format": "double" }, "amountsByCurrency": { "items": { "$ref": "#/definitions/BudgetCurrencyAmount" }, "type": "array" } }, "required": [ "id", "budgetReferenceId", "type", "communityId", "fundedAmount", "spentAmount" ], "type": "object", "additionalProperties": false }, "CommunityBudgetsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/BudgetEntity" }, "type": "array" }, "meta": { "properties": { "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "BulkBudgetCreateResponse": { "properties": { "created": { "items": { "$ref": "#/definitions/BudgetEntity" }, "type": "array" }, "conflicts": { "items": { "properties": { "message": { "type": "string" }, "budgetReferenceId": { "type": "string" } }, "required": [ "message", "budgetReferenceId" ], "type": "object" }, "type": "array" }, "errors": { "items": { "properties": { "error": { "type": "string" }, "budgetReferenceId": { "type": "string" } }, "required": [ "error", "budgetReferenceId" ], "type": "object" }, "type": "array" } }, "required": [ "created", "conflicts", "errors" ], "type": "object", "additionalProperties": false }, "BudgetCreateRequest": { "properties": { "budgetReferenceId": { "type": "string" }, "budgetReferenceIdType": { "$ref": "#/definitions/BudgetReferenceIdType" }, "name": { "type": "string" }, "communityId": { "type": "string" } }, "required": [ "budgetReferenceId", "budgetReferenceIdType", "name", "communityId" ], "type": "object", "additionalProperties": false }, "BulkBudgetCreateDTO": { "properties": { "budgets": { "items": { "$ref": "#/definitions/BudgetCreateRequest" }, "type": "array" } }, "required": [ "budgets" ], "type": "object", "additionalProperties": false }, "Pick_BudgetCreateRequest.Exclude_keyofBudgetCreateRequest.communityId__": { "properties": { "name": { "type": "string" }, "budgetReferenceId": { "type": "string" }, "budgetReferenceIdType": { "$ref": "#/definitions/BudgetReferenceIdType" } }, "required": [ "name", "budgetReferenceId", "budgetReferenceIdType" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_BudgetCreateRequest.communityId_": { "$ref": "#/definitions/Pick_BudgetCreateRequest.Exclude_keyofBudgetCreateRequest.communityId__", "description": "Construct a type with the properties of T except for those in type K." }, "BudgetCreateDTO": { "$ref": "#/definitions/Omit_BudgetCreateRequest.communityId_" }, "PostMetric": { "properties": { "activationId": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "network": { "type": "string" }, "ugcPhoto": { "type": "string" }, "image": { "type": "string", "x-nullable": true }, "text": { "type": "string", "x-nullable": true }, "postLink": { "type": "string" }, "date": { "type": "string" }, "engagements": { "type": "number", "format": "double" }, "benchmarkAverageEngagements": { "type": "number", "format": "double" }, "engagementRate": { "type": "number", "format": "double" }, "engagementRateDif": { "type": "number", "format": "double" }, "benchmarkEngagementRate": { "type": "number", "format": "double" }, "reach": { "type": "number", "format": "double" }, "impressionsEngagementRate": { "type": "number", "format": "double" }, "emvValue": { "type": "number", "format": "double" } }, "required": [ "activationId", "impressions", "network", "ugcPhoto", "image", "text", "postLink", "date", "engagements", "benchmarkAverageEngagements", "engagementRate", "engagementRateDif", "benchmarkEngagementRate", "reach", "impressionsEngagementRate", "emvValue" ], "type": "object", "additionalProperties": false }, "TopInfluencerMetrics": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePhoto": { "type": "string", "x-nullable": true }, "instagramHandle": { "type": "string", "x-nullable": true }, "igProfilePhoto": { "type": "string", "x-nullable": true }, "facebookAvatar": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "impressionsEngagementRate": { "type": "number", "format": "double" }, "content": { "type": "number", "format": "double" }, "emvValue": { "type": "number", "format": "double" }, "roiValue": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "firstName", "lastName", "profilePhoto", "instagramHandle", "igProfilePhoto", "facebookAvatar", "globalUserId", "membershipId", "impressions", "engagements", "impressionsEngagementRate", "content", "emvValue" ], "type": "object", "additionalProperties": false }, "TopInfluencerConversions": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePhoto": { "type": "string", "x-nullable": true }, "instagramHandle": { "type": "string", "x-nullable": true }, "igProfilePhoto": { "type": "string", "x-nullable": true }, "facebookAvatar": { "type": "string", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "clicks": { "type": "number", "format": "double" }, "conversions": { "type": "number", "format": "double" }, "conversionsValue": { "type": "number", "format": "double" } }, "required": [ "firstName", "lastName", "profilePhoto", "instagramHandle", "igProfilePhoto", "facebookAvatar", "globalUserId", "membershipId", "clicks", "conversions", "conversionsValue" ], "type": "object", "additionalProperties": false }, "CampaignPlatformSubscriptionIdentifierPayload": { "properties": { "subscriptionId": { "type": "string", "x-nullable": true }, "platformSubscriptionId": { "type": "string", "x-nullable": true } }, "additionalProperties": { "additionalProperties": true }, "type": "object" }, "CampaignPlatformYoutubeActivationPayload": { "properties": { "viewsPaid": { "type": "number", "format": "double", "x-nullable": true }, "viewsOrganic": { "type": "number", "format": "double", "x-nullable": true }, "views": { "type": "number", "format": "double", "x-nullable": true }, "videoViewTotalTime": { "type": "number", "format": "double", "x-nullable": true }, "videoCompletionRate": { "type": "number", "format": "double", "x-nullable": true }, "verifiedImpressions": { "type": "number", "format": "double", "x-nullable": true }, "text": { "type": "string", "x-nullable": true }, "sharesPaid": { "type": "number", "format": "double", "x-nullable": true }, "sharesOrganic": { "type": "number", "format": "double", "x-nullable": true }, "shares": { "type": "number", "format": "double", "x-nullable": true }, "reach": { "type": "number", "format": "double", "x-nullable": true }, "postLink": { "type": "string", "x-nullable": true }, "postDate": { "type": "object" }, "network": { "type": "string", "x-nullable": true }, "likesPaid": { "type": "number", "format": "double", "x-nullable": true }, "likesOrganic": { "type": "number", "format": "double", "x-nullable": true }, "likes": { "type": "number", "format": "double", "x-nullable": true }, "impressionsSource": { "type": "string", "x-nullable": true }, "image": { "type": "string", "x-nullable": true }, "followersAtPostDate": { "type": "number", "format": "double", "x-nullable": true }, "externalId": { "type": "string", "x-nullable": true }, "engagements": { "type": "number", "format": "double", "x-nullable": true }, "contentType": { "type": "string", "x-nullable": true }, "comments": { "type": "number", "format": "double", "x-nullable": true }, "caption": { "type": "string", "x-nullable": true } }, "type": "object" }, "CampaignPlatformBindingCorrelationMetadata": { "properties": { "listMemberId": { "type": "number", "format": "double" }, "liCampaignId": { "type": "number", "format": "double" } }, "additionalProperties": { "additionalProperties": true }, "required": [ "listMemberId", "liCampaignId" ], "type": "object" }, "CampaignPlatformSubscriptionCallbackPayload": { "type": "object", "properties": {} }, "Metadata": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "offset", "limit", "totalCount" ], "type": "object" }, "GetAllCampaignsResponse": { "properties": { "meta": { "$ref": "#/definitions/Metadata" }, "data": { "items": { "$ref": "#/definitions/Campaign" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object" }, "CampaignURI": { "properties": { "name": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "name", "id" ], "type": "object" }, "ReportingGroupIdsRespnse": { "properties": { "ids": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "ids" ], "type": "object" }, "Partial_CashPaymentAppResponse_": { "properties": { "id": { "type": "number", "format": "double" }, "provider": { "type": "string" }, "identifier": { "type": "string" }, "secretKey": { "type": "string" }, "environment": { "type": "string", "x-nullable": true }, "accessToken": { "type": "string", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "externalDescription": { "type": "string", "x-nullable": true }, "includeFeesInTransactions": { "type": "boolean" }, "paymentAccount": { "properties": { "cashPaymentApp": { "properties": { "includeFeesInTransactions": { "type": "boolean" }, "externalDescription": { "type": "string", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "accessToken": { "type": "string", "x-nullable": true }, "environment": { "type": "string", "x-nullable": true }, "secretKey": { "type": "string" }, "identifier": { "type": "string" }, "provider": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "includeFeesInTransactions", "externalDescription", "internalIdentifierCode", "updatedAt", "createdAt", "accessToken", "environment", "secretKey", "identifier", "provider", "id" ], "type": "object" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "accountType": { "type": "string", "x-nullable": true }, "description": { "type": "string" }, "balance": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "updatedAt", "createdAt", "cashPaymentAppId", "accountType", "description", "balance", "communityId", "id" ], "type": "object" } }, "type": "object", "description": "Make all properties in T optional" }, "ProviderEnvironment": { "enum": [ "LIVE", "SANDBOX" ], "type": "string" }, "DBCashPaymentAppProvider": { "enum": [ "PAYPAL", "STRIPE", "MAVELY", "TIPALTI" ], "type": "string" }, "CreateCashPaymentAppBody": { "properties": { "tipaltiPayerEntityId": { "type": "string", "x-nullable": true, "description": "Passed through to Payment Service only; not stored in SAPI" }, "iframeMasterKey": { "type": "string", "x-nullable": true, "description": "Passed through to Payment Service only; not stored in SAPI" }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "s4AccountIdsToGiveAdminAccess": { "items": { "type": "number", "format": "double" }, "type": "array" }, "secretKey": { "type": "string" }, "provider": { "$ref": "#/definitions/DBCashPaymentAppProvider" }, "identifier": { "type": "string" }, "environment": { "$ref": "#/definitions/ProviderEnvironment" }, "description": { "type": "string" }, "additionalCommunityIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "s4AccountIdsToGiveAdminAccess", "secretKey", "provider", "identifier", "environment", "description", "additionalCommunityIds" ], "type": "object" }, "Pick_CashPaymentApp.Exclude_keyofCashPaymentApp.secretKey__": { "properties": { "id": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "provider": { "type": "string" }, "identifier": { "type": "string" }, "environment": { "type": "string", "x-nullable": true }, "accessToken": { "type": "string", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "externalDescription": { "type": "string", "x-nullable": true }, "includeFeesInTransactions": { "type": "boolean" }, "iframeMasterKey": { "type": "string", "x-nullable": true, "description": "Payment Service only; not mirrored in SAPI DB." }, "tipaltiPayerEntityId": { "type": "string", "x-nullable": true, "description": "Payment Service only; not mirrored in SAPI DB." } }, "required": [ "id", "provider", "identifier", "environment", "internalIdentifierCode", "externalDescription", "includeFeesInTransactions" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_CashPaymentApp.secretKey_": { "$ref": "#/definitions/Pick_CashPaymentApp.Exclude_keyofCashPaymentApp.secretKey__", "description": "Construct a type with the properties of T except for those in type K." }, "CashPaymentAppUpdateResponse": { "type": "object", "properties": {} }, "Partial_CashPaymentApp_": { "properties": { "id": { "type": "number", "format": "double" }, "provider": { "type": "string" }, "identifier": { "type": "string" }, "secretKey": { "type": "string" }, "environment": { "type": "string", "x-nullable": true }, "accessToken": { "type": "string", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "externalDescription": { "type": "string", "x-nullable": true }, "includeFeesInTransactions": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "iframeMasterKey": { "type": "string", "x-nullable": true, "description": "Payment Service only; not mirrored in SAPI DB." }, "tipaltiPayerEntityId": { "type": "string", "x-nullable": true, "description": "Payment Service only; not mirrored in SAPI DB." } }, "type": "object", "description": "Make all properties in T optional" }, "CashPaymentAppUpdatePayload": { "type": "object", "properties": {} }, "DBAnonymousComment": { "properties": { "id": { "type": "number", "format": "double" }, "text": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true }, "communityId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "text", "email", "communityId", "createdAt" ], "type": "object", "additionalProperties": false }, "CreateAnonymousCommentBody": { "properties": { "text": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true } }, "required": [ "text", "email" ], "type": "object", "additionalProperties": false }, "QueryAnonymousCommentsResult": { "properties": { "data": { "items": { "$ref": "#/definitions/DBAnonymousComment" }, "type": "array" }, "meta": { "properties": { "totalCount": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" } }, "required": [ "totalCount", "limit", "offset" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "Comment": { "properties": { "author": { "$ref": "#/definitions/Administrator" }, "createdAt": { "type": "string" }, "id": { "type": "number", "format": "double" }, "text": { "type": "string" }, "pinned": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "Pick_Comment.id_": { "properties": { "id": { "type": "number", "format": "double" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "GlobalUserCommentPostBody": { "properties": { "text": { "type": "string" }, "resource": { "properties": { "type": { "type": "string", "enum": [ "ActionGroup" ], "x-nullable": false }, "id": { "type": "number", "format": "double" } }, "required": [ "type", "id" ], "type": "object" } }, "required": [ "text" ], "type": "object", "additionalProperties": false }, "GlobalUserCommentPatchBody": { "properties": { "pinned": { "type": "boolean" } }, "required": [ "pinned" ], "type": "object", "additionalProperties": false }, "NotificationComment": { "properties": { "id": { "type": "number", "format": "double" }, "occurredAt": { "type": "string" }, "author": { "type": "string" }, "authorImage": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "text": { "type": "string" } }, "required": [ "id", "occurredAt", "resourceType", "resourceId", "text" ], "type": "object", "additionalProperties": false }, "ResponseBody_NotificationComment-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/NotificationComment" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "IdObject": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "Pick_NotificationComment.text-or-resourceType-or-resourceId_": { "properties": { "text": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "type": "string" } }, "required": [ "text", "resourceType", "resourceId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "NotificationCommentPostBody": { "$ref": "#/definitions/Pick_NotificationComment.text-or-resourceType-or-resourceId_" }, "CommSiteInfo": { "properties": { "accent_color": { "type": "string" }, "affiliateProviders": { "additionalProperties": true }, "back_color": { "type": "string" }, "back_img": { "type": "string" }, "banner_img": { "type": "string" }, "bazaar_app_id": { "type": "number", "format": "double" }, "bazaar_voice_enabled": { "type": "boolean" }, "bluekai_enabled": { "type": "boolean" }, "bluekai_site_id": { "type": "string" }, "button_color": { "type": "string" }, "cc_img": { "type": "string" }, "cc_text": { "type": "string" }, "cc_url": { "type": "string" }, "community_id": { "type": "string" }, "community_name": { "type": "string" }, "community_url": { "type": "string" }, "conversion_contest_action_id": { "type": "string" }, "conversion_contest_conversion_count_target": { "type": "number", "format": "double" }, "conversion_contest_reward_description": { "type": "string" }, "custom_css": { "type": "string" }, "custom_scripts": { "type": "string" }, "customer_website": { "type": "string" }, "default_country": { "type": "string" }, "description": { "type": "string" }, "displayName": { "type": "string" }, "email": { "type": "string" }, "end_date": { "type": "string" }, "facebook_app_name": { "type": "string" }, "fav_icon": { "type": "string" }, "fb_app_id": { "type": "string" }, "fb_app_version": { "type": "string" }, "fb_conversation_html": { "type": "string" }, "fb_conversation_image": { "type": "string" }, "fb_conversation_link": { "type": "string" }, "fb_featured_post": { "type": "string" }, "fb_id": { "type": "string" }, "footer": { "type": "string" }, "google_property_id": { "type": "string" }, "has_gb_referrals_enabled": { "type": "boolean" }, "has_points_enabled": { "type": "boolean" }, "has_policy_link_in_footer": { "type": "boolean" }, "header_frame_link": { "type": "string" }, "headline_color": { "type": "string" }, "help_url": { "type": "string" }, "instagram_handle": { "type": "string" }, "instagram_square_image": { "type": "string" }, "launch_date": { "type": "string" }, "locale": { "type": "string" }, "logo_large": { "type": "string" }, "logo_medium": { "type": "string" }, "logo_small": { "type": "string" }, "num_actions_displayed": { "type": "number", "format": "double" }, "og_image": { "type": "string" }, "onboarding_section_enabled": { "type": "boolean" }, "paypal_enabled": { "type": "boolean" }, "permissions": { "type": "string" }, "pinterest_app_id": { "type": "string" }, "pinterest_app_version": { "type": "number", "format": "double" }, "points": { "additionalProperties": true }, "pointsForPurchaseRatio": { "type": "number", "format": "double" }, "points_per_member_referred": { "type": "number", "format": "double" }, "policy_link": { "type": "string" }, "post_signup_tags": { "type": "string" }, "privacy_custom_text": { "type": "string" }, "privacy_policy_link_text": { "type": "string" }, "privacy_policy_required": { "type": "boolean" }, "publish_og_story": { "type": "boolean" }, "referral_email_enabled": { "type": "boolean" }, "referral_facebook_enabled": { "type": "boolean" }, "referral_link_route": { "type": "string" }, "referral_program_description": { "type": "string" }, "referral_text": { "type": "string" }, "referral_twitter_enabled": { "type": "boolean" }, "referral_widget_enabled": { "type": "boolean" }, "rejected_user_redirect_link": { "type": "string" }, "required_to_view_all_contracts": { "type": "object" }, "retired": { "type": "boolean" }, "signature_required": { "type": "boolean" }, "start_date": { "type": "string" }, "status": { "type": "string" }, "tagline": { "type": "string" }, "tango_card_enabled": { "type": "boolean" }, "terms_link": { "type": "string" }, "terms_of_use_link_text": { "type": "string" }, "tiktokAppId": { "type": "string" }, "tiktokAppRid": { "type": "string" }, "tiktokAppScope": { "type": "string" }, "url": { "type": "string" }, "usage_details": { "type": "string" }, "widgetsToShow": { "items": { "type": "string" }, "type": "array" }, "isTest": { "type": "boolean" } }, "required": [ "accent_color", "button_color", "community_id", "community_url", "default_country", "fb_app_id", "has_gb_referrals_enabled", "has_points_enabled", "locale", "og_image", "pointsForPurchaseRatio", "privacy_policy_required", "referral_email_enabled", "referral_facebook_enabled", "referral_twitter_enabled", "referral_widget_enabled", "retired", "signature_required", "start_date", "terms_link", "isTest" ], "type": "object", "additionalProperties": false }, "UpdateCommunityInfoFieldsDTO": { "properties": { "weekly_digest_subscribers": { "type": "string" }, "weekly_digest_preference": { "type": "string" }, "usage_details": { "type": "string" }, "url": { "type": "string" }, "terms_of_use_link_text": { "type": "string" }, "terms_link": { "type": "string" }, "tagline": { "type": "string" }, "required_to_view_all_contracts": { "type": "object" }, "referral_widget_enabled": { "type": "object" }, "referral_twitter_enabled": { "type": "object" }, "referral_text": { "type": "string" }, "referral_link_route": { "type": "string" }, "referral_facebook_enabled": { "type": "object" }, "referral_email_enabled": { "type": "number", "format": "double" }, "referral_confirmation_email_text": { "type": "string" }, "privacy_policy_required": { "type": "object" }, "privacy_policy_link_text": { "type": "string" }, "policy_link": { "type": "string" }, "points_per_referral_click": { "type": "string" }, "points_per_member_referred": { "type": "number", "format": "double" }, "og_image": { "type": "string" }, "logo_small": { "type": "string" }, "locale": { "type": "string" }, "launch_date": { "type": "string" }, "instagram_square_image": { "type": "string" }, "instagram_handle": { "type": "string" }, "help_url": { "type": "string" }, "headline_color": { "type": "string" }, "has_points_enabled": { "type": "object" }, "fav_icon": { "type": "string" }, "email_header_image_url": { "type": "string" }, "email_domain_white_labeled": { "type": "object" }, "description": { "type": "string" }, "default_country": { "type": "string" }, "community_url": { "type": "string" }, "community_name": { "type": "string" }, "button_color": { "type": "string" }, "back_img": { "type": "string" }, "back_color": { "type": "string" }, "accent_color": { "type": "string" } }, "type": "object" }, "DBCommunityNews": { "properties": { "id": { "type": "number", "format": "double" }, "community_id": { "type": "string" }, "title": { "type": "string" }, "desc": { "type": "string" }, "img": { "type": "string" }, "link": { "type": "string" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "order": { "type": "number", "format": "double" }, "status": { "type": "string" } }, "required": [ "id", "community_id", "title", "desc", "img", "link", "start_date", "end_date", "order", "status" ], "type": "object", "additionalProperties": false }, "ConceptContentCommentPostResponse": { "$ref": "#/definitions/ConceptContentCommentEntry" }, "ConceptContentCommentPostBody": { "properties": { "commenterName": { "type": "string" }, "text": { "type": "string" } }, "required": [ "text" ], "type": "object", "additionalProperties": false }, "ConceptContentCommentPutBody": { "properties": { "isArchived": { "type": "boolean" } }, "required": [ "isArchived" ], "type": "object", "additionalProperties": false }, "ConceptContentStatusUpdateBody": { "description": "The status a reviewer may set. Excludes `pending` — that is the submitted/awaiting state\nseeded on submission, not a reviewer action (mirrors drafts). The path param is authoritative,\nso the body carries only the status (no redundant id / envelope).", "properties": { "status": { "type": "string", "enum": [ "approved", "conditionally_approved", "rejected", "rejected_no_notification" ], "x-nullable": false } }, "required": [ "status" ], "type": "object", "additionalProperties": false }, "ConceptContentFeedbackUpdateBody": { "properties": { "feedback": { "type": "string" } }, "required": [ "feedback" ], "type": "object" }, "ResponseBody_ConceptContentFeedbackEntry-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/ConceptContentFeedbackEntry" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "AdminConceptContentPostBody": { "properties": { "contentType": { "type": "string" }, "contentUrl": { "type": "string" }, "files": { "items": { "$ref": "#/definitions/InfluencerConceptContentPostFile" }, "type": "array" }, "notes": { "type": "string" }, "text": { "type": "string" }, "threadId": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" } }, "required": [ "globalUserId", "campaignId" ], "type": "object", "additionalProperties": false }, "ConceptContentUpdateBody": { "properties": { "isArchived": { "type": "boolean" }, "files": { "items": { "$ref": "#/definitions/InfluencerConceptContentPostFile" }, "type": "array" }, "text": { "type": "string" }, "notes": { "type": "string" }, "contentUrl": { "type": "string" } }, "type": "object", "additionalProperties": false }, "ConceptViewed": { "properties": { "email": { "type": "string" }, "conceptId": { "type": "number", "format": "double" }, "viewedAt": { "type": "string", "format": "date-time" } }, "required": [ "email", "conceptId", "viewedAt" ], "type": "object", "additionalProperties": false }, "CreateConceptContentViewed": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object", "additionalProperties": false }, "Content": { "properties": { "content": { "$ref": "#/definitions/ContentInfo" }, "binding": { "properties": { "source": { "type": "string" }, "dateBound": { "type": "number", "format": "double" }, "administrator": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object" }, "globalUser": { "properties": { "membership": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object" }, "listMember": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object" }, "id": { "type": "number", "format": "double" } }, "required": [ "membership", "listMember", "id" ], "type": "object" }, "campaign": { "properties": { "type": { "type": "string" }, "listId": { "type": "number", "format": "double" }, "title": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "type", "id" ], "type": "object" }, "instance": { "properties": { "name": { "type": "string" }, "id": { "type": "string" } }, "required": [ "id" ], "type": "object" }, "id": { "type": "number", "format": "double" } }, "required": [ "source", "dateBound", "campaign", "instance", "id" ], "type": "object" } }, "required": [ "content", "binding" ], "type": "object" }, "ContentResponse": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/Content" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object" }, "ConversationTemplatesGetResponse": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ConversationTemplate" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "GetConversationTemplateByIdResponse": { "type": "object" }, "ConversationTemplatePostResponse": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ConversationTemplatePostBody": { "properties": { "category": { "type": "string" }, "html": { "type": "string" }, "isArchived": { "type": "boolean" }, "subject": { "type": "string" }, "title": { "type": "string" } }, "required": [ "category", "html", "subject", "title" ], "type": "object", "additionalProperties": false }, "ConversationTemplatePutBody": { "properties": { "category": { "type": "string" }, "html": { "type": "string" }, "createdAt": { "type": "string" }, "isArchived": { "type": "boolean" }, "subject": { "type": "string" }, "title": { "type": "string" }, "version": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "ConversationBulkActionRequestBody": { "properties": { "conversationIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "search": { "type": "string" } }, "type": "object", "additionalProperties": false }, "UploadInlineImageResult": { "properties": { "link": { "type": "string" } }, "required": [ "link" ], "type": "object", "additionalProperties": false }, "CatalogResponseTag": { "properties": { "subtitleI18nKey": { "type": "string" }, "subtitle": { "type": "string" }, "titleI18nKey": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string", "enum": [ "data", "link" ], "x-nullable": false }, "key": { "type": "string" } }, "required": [ "kind", "key" ], "type": "object" }, "CatalogResponseGroup": { "properties": { "tags": { "items": { "$ref": "#/definitions/CatalogResponseTag" }, "type": "array" }, "emptyTextI18nKey": { "type": "string" }, "titleI18nKey": { "type": "string" }, "key": { "type": "string" } }, "required": [ "tags", "titleI18nKey", "key" ], "type": "object" }, "MergeTagsCatalogResponse": { "properties": { "groups": { "items": { "$ref": "#/definitions/CatalogResponseGroup" }, "type": "array" } }, "required": [ "groups" ], "type": "object" }, "DBMessageEvent": { "properties": { "email": { "type": "string" }, "status": { "type": "string" }, "reason": { "type": "string" }, "userAgent": { "type": "string" }, "ip": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "event": { "type": "object" }, "sgEventId": { "type": "string" }, "messageId": { "type": "object" }, "id": { "type": "number", "format": "double" } }, "required": [ "occurredAt", "event", "messageId" ], "type": "object" }, "QueryByMessageResult": { "properties": { "data": { "items": { "$ref": "#/definitions/DBMessageEvent" }, "type": "array" }, "meta": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "ResponseBody_ConversionTag-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/ConversionTag" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ConversionTagPostBody": { "properties": { "name": { "type": "string" }, "communityId": { "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "ConversionTagPutBody": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "CreatorSummaryDTO": { "properties": { "creatorPersona": { "type": "string" }, "platformPresence": { "properties": { "insights": { "type": "string" } }, "required": [ "insights" ], "type": "object" }, "contentFormatBreakdown": { "properties": { "formats": { "items": { "type": "string" }, "type": "array" }, "overview": { "type": "string", "x-nullable": true, "description": "Null when no formats are confirmed, in which case the section is omitted entirely." } }, "required": [ "formats", "overview" ], "type": "object" }, "contentStyle": { "type": "string", "x-nullable": true, "description": "Null when the payload carried no posts to describe." }, "contentThemesAndNiches": { "properties": { "themes": { "items": { "type": "string" }, "type": "array" }, "context": { "type": "string" } }, "required": [ "themes", "context" ], "type": "object" }, "audience": { "type": "string" }, "brandPartnerships": { "type": "string" } }, "required": [ "creatorPersona", "platformPresence", "contentFormatBreakdown", "contentStyle", "contentThemesAndNiches", "audience", "brandPartnerships" ], "type": "object", "additionalProperties": false }, "CachedCreatorSummaryResponse": { "properties": { "summary": { "$ref": "#/definitions/CreatorSummaryDTO", "description": "Structured, per-section summary object." }, "rendered": { "type": "string", "description": "Ready-to-read rendered summary with section headers." }, "wordCount": { "type": "number", "format": "double" }, "generatedAt": { "type": "string", "description": "ISO date-time the summary was generated." }, "version": { "type": "number", "format": "double", "description": "Prompt/schema version the summary was generated with." }, "cached": { "type": "boolean", "description": "True when served from the creator-summary table, false when generated on this request." } }, "required": [ "summary", "rendered", "wordCount", "generatedAt", "version", "cached" ], "type": "object", "additionalProperties": false }, "CustomAnalyticsConfigResponse": { "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "roleIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "prefersDark": { "type": "string", "x-nullable": true }, "themeId": { "type": "string", "x-nullable": true }, "filters": { "type": "string", "x-nullable": true }, "userAttributes": { "properties": { "brand_id": { "items": { "type": "string" }, "type": "array" }, "instance_id": { "items": { "type": "string" }, "type": "array" } }, "type": "object", "x-nullable": true }, "isDefault": { "type": "boolean" }, "externalDashboardId": { "type": "string" }, "dashboardType": { "type": "string" }, "communityId": { "type": "string", "x-nullable": true, "description": "The community this config applies to.\nIf null, this is a default template that applies to any community\nwithout a community-specific override." }, "id": { "type": "number", "format": "double" } }, "required": [ "updatedAt", "createdAt", "isDefault", "externalDashboardId", "dashboardType", "communityId", "id" ], "type": "object" }, "CustomAnalyticsConfigsListResponse": { "properties": { "meta": { "properties": { "total": { "type": "number", "format": "double" } }, "type": "object" }, "data": { "items": { "$ref": "#/definitions/CustomAnalyticsConfigResponse" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "CreateCustomAnalyticsConfigRequest": { "properties": { "roleIds": { "items": { "type": "number", "format": "double" }, "type": "array", "description": "Optional array of role IDs that can access this config.\nIf not provided or empty, the config is accessible to anyone with root/administrator/contributor roles (no role restrictions)." }, "prefersDark": { "type": "string" }, "themeId": { "type": "string" }, "filters": { "type": "string" }, "userAttributes": { "properties": { "brand_id": { "items": { "type": "string" }, "type": "array" }, "instance_id": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "externalDashboardId": { "type": "string" }, "dashboardType": { "type": "string" }, "communityId": { "type": "string", "x-nullable": true, "description": "The community this config applies to.\nIf null or omitted, creates a default template for the given dashboardType.\nDefault templates apply to any community that doesn't have a community-specific override." } }, "required": [ "externalDashboardId", "dashboardType" ], "type": "object" }, "UpdateCustomAnalyticsConfigRequest": { "properties": { "roleIds": { "items": { "type": "number", "format": "double" }, "type": "array", "description": "Optional array of role IDs that can access this config.\nIf provided, replaces all existing role associations.\nIf empty array, clears all role restrictions (accessible to anyone with root/administrator/contributor roles).\nIf undefined, role associations remain unchanged." }, "prefersDark": { "type": "string" }, "themeId": { "type": "string" }, "filters": { "type": "string" }, "userAttributes": { "properties": { "brand_id": { "items": { "type": "string" }, "type": "array" }, "instance_id": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "externalDashboardId": { "type": "string" }, "dashboardType": { "type": "string" } }, "type": "object" }, "EmbedUrlResponse": { "properties": { "embed_url": { "type": "string" } }, "required": [ "embed_url" ], "type": "object" }, "DashboardTypesResponse": { "properties": { "dashboardTypes": { "items": { "type": "string" }, "type": "array" }, "instanceId": { "type": "string" } }, "required": [ "dashboardTypes", "instanceId" ], "type": "object" }, "GlobalUserId": { "type": "number", "format": "double" }, "Pick_GlobalUser.id-or-uuid_": { "properties": { "id": { "$ref": "#/definitions/GlobalUserId" }, "uuid": { "type": "string" } }, "required": [ "id" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "FraudLevel": { "enum": [ "low", "medium", "high" ], "type": "string" }, "MvkInstagramAccount": { "properties": { "id": { "type": "number", "format": "double" }, "username": { "type": "string" }, "externalId": { "type": "string" }, "bio": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "primaryAccount": { "type": "boolean" }, "averageLikes": { "type": "number", "format": "double" }, "mediaCount": { "type": "number", "format": "double" }, "averageComments": { "type": "number", "format": "double" }, "averageEngagements": { "type": "number", "format": "double" }, "engagementRage": { "type": "number", "format": "double" }, "sponsoredPostRate": { "type": "number", "format": "double" }, "isBusiness": { "type": "boolean" }, "isPrivate": { "type": "boolean" }, "audienceFraudLevel": { "$ref": "#/definitions/FraudLevel" } }, "required": [ "username", "externalId" ], "type": "object", "additionalProperties": false }, "MvkPinterestAccount": { "properties": { "id": { "type": "number", "format": "double" }, "username": { "type": "string" }, "externalId": { "type": "string" }, "bio": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "primaryAccount": { "type": "boolean" }, "boardsCount": { "type": "number", "format": "double" }, "pinsCount": { "type": "number", "format": "double" }, "monthlyViewers": { "type": "number", "format": "double" } }, "required": [ "username", "externalId" ], "type": "object", "additionalProperties": false }, "MvkYoutubeChannel": { "properties": { "id": { "type": "number", "format": "double" }, "username": { "type": "string" }, "externalId": { "type": "string" }, "bio": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "primaryAccount": { "type": "boolean" }, "userId": { "type": "number", "format": "double" }, "videoCount": { "type": "number", "format": "double" }, "commentCount": { "type": "number", "format": "double" }, "viewCount": { "type": "number", "format": "double" } }, "required": [ "username", "externalId" ], "type": "object", "additionalProperties": false }, "MvkTwitterAccount": { "properties": { "id": { "type": "number", "format": "double" }, "username": { "type": "string" }, "externalId": { "type": "string" }, "bio": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "primaryAccount": { "type": "boolean" }, "description": { "type": "string" }, "verified": { "type": "boolean" }, "averageFavorites": { "type": "number", "format": "double" }, "averageRetweets": { "type": "number", "format": "double" } }, "required": [ "username", "externalId" ], "type": "object", "additionalProperties": false }, "MvkSocialAccount": { "properties": { "id": { "type": "number", "format": "double" }, "username": { "type": "string" }, "externalId": { "type": "string" }, "bio": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "followersCount": { "type": "number", "format": "double" }, "profilePicture": { "type": "string" }, "primaryAccount": { "type": "boolean" } }, "required": [ "username", "externalId" ], "type": "object", "additionalProperties": false }, "MvkFacebookProfile": { "$ref": "#/definitions/MvkSocialAccount" }, "MvkBlog": { "properties": { "id": { "type": "number", "format": "double" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "url" ], "type": "object", "additionalProperties": false }, "Partial_GlobalUser_": { "properties": { "id": { "$ref": "#/definitions/GlobalUserId" }, "uuid": { "type": "string" }, "instagram": { "$ref": "#/definitions/MvkInstagramAccount" }, "pinterest": { "$ref": "#/definitions/MvkPinterestAccount" }, "youtube": { "$ref": "#/definitions/MvkYoutubeChannel" }, "twitter": { "$ref": "#/definitions/MvkTwitterAccount" }, "facebook": { "$ref": "#/definitions/MvkFacebookProfile" }, "blog": { "$ref": "#/definitions/MvkBlog" } }, "type": "object", "description": "Make all properties in T optional" }, "RequestData": { "properties": { "data": { "items": { "$ref": "#/definitions/Partial_GlobalUser_" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "DBDataPointDefinition": { "properties": { "archived": { "type": "boolean" }, "mergeTag": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "communityId": { "type": "string" }, "type": { "type": "string" }, "customSet": { "type": "boolean" }, "markUpDescription": { "type": "string", "x-nullable": true }, "multi": { "type": "boolean" }, "description": { "type": "string", "x-nullable": true }, "name": { "type": "string" }, "key": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" } }, "required": [ "archived", "mergeTag", "updatedAt", "createdAt", "communityId", "type", "customSet", "multi", "description", "name", "key", "id" ], "type": "object" }, "MembershipDataPointWithDefinitions": { "properties": { "lastEditedByAccountId": { "type": "number", "format": "double" }, "isConfirmedByMember": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "dataPointDefinitionId": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "value": { "type": "string" }, "id": { "type": "number", "format": "double" }, "dataPointDefinition": { "$ref": "#/definitions/DBDataPointDefinition" } }, "required": [ "lastEditedByAccountId", "isConfirmedByMember", "updatedAt", "createdAt", "dataPointDefinitionId", "membershipId", "value", "id", "dataPointDefinition" ], "type": "object", "additionalProperties": false }, "UpdateMembershipDataPointBody": { "properties": { "value": { "items": { "type": "string" }, "type": "array" } }, "required": [ "value" ], "type": "object", "additionalProperties": false }, "DraftContentCommentPostResponse": { "$ref": "#/definitions/InfluencerDraftContentComment" }, "DraftContentCommentPostBody": { "properties": { "commenterName": { "type": "string" }, "text": { "type": "string" } }, "required": [ "text" ], "type": "object", "additionalProperties": false }, "DraftContentCommentPutBody": { "properties": { "isArchived": { "type": "boolean" } }, "required": [ "isArchived" ], "type": "object", "additionalProperties": false }, "ResponseBody_DraftContentFeedbackEntry-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/DraftContentFeedbackEntry" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "DraftContentViewed": { "properties": { "email": { "type": "string" }, "draftContentId": { "type": "number", "format": "double" }, "viewedAt": { "type": "string", "format": "date-time" } }, "required": [ "email", "draftContentId", "viewedAt" ], "type": "object", "additionalProperties": false }, "CreateDraftContentViewed": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object", "additionalProperties": false }, "UpdateEmvParams": { "properties": { "periodStart": { "type": "string" }, "periodEnd": { "type": "string" } }, "type": "object", "additionalProperties": false }, "GlobalUserElasticsearchDocument": { "properties": { "audienceFakeEngagersLevel": { "type": "number", "format": "double", "x-nullable": true }, "audienceFakeFollowersLevel": { "type": "number", "format": "double", "x-nullable": true }, "audienceFraudLevel": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_13_17": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_18_24": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_25_34": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_35_44": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_45_54": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_55_64": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_65_plus": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentageFemale": { "type": "number", "format": "double", "x-nullable": true }, "audiencePredominantAgeRange": { "type": "string", "x-nullable": true }, "audiencePredominantCity": { "type": "string", "x-nullable": true }, "audiencePredominantCountry": { "type": "string", "x-nullable": true }, "blog": { "type": "string", "x-nullable": true }, "deleted": { "type": "boolean" }, "email": { "type": "string" }, "fullName": { "type": "string" }, "id": { "type": "number", "format": "double" }, "instagramAccount": { "additionalProperties": true, "x-nullable": true }, "instagramHandle": { "type": "string", "x-nullable": true }, "instagramPost": { "type": "string", "x-nullable": true }, "lists": { "items": { "type": "number", "format": "double" }, "type": "array" }, "loadSource": { "type": "string", "x-nullable": true }, "memberships": { "items": { "properties": { "zip": { "type": "string" }, "street": { "type": "string" }, "state": { "type": "string" }, "phone": { "type": "string" }, "mostRecentActivationDate": { "type": "string", "x-nullable": true }, "memberSelectedEthnicities": { "items": { "properties": { "ethnicGroupDescription": { "type": "string" }, "ethnicGroup": { "type": "string" } }, "type": "object" }, "type": "array" }, "membershipId": { "type": "number", "format": "double" }, "lifetimeValue": { "type": "number", "format": "double" }, "lifetimeImpressions": { "type": "number", "format": "double" }, "lifetimeConversions": { "type": "number", "format": "double" }, "lifetimeClicks": { "type": "number", "format": "double" }, "gender": { "$ref": "#/definitions/Gender" }, "fullName": { "type": "string" }, "facebookProfile": { "additionalProperties": true }, "email": { "type": "string" }, "dataPoint": { "items": { "additionalProperties": true }, "type": "array" }, "createdAt": { "type": "string" }, "cpp": { "type": "number", "format": "double", "x-nullable": true }, "cpm": { "type": "number", "format": "double", "x-nullable": true }, "cpe": { "type": "number", "format": "double", "x-nullable": true }, "country": { "type": "string" }, "communityId": { "type": "string" }, "city": { "type": "string" }, "birthday": { "type": "string" }, "apt": { "type": "string", "x-nullable": true } }, "type": "object" }, "type": "array" }, "nudityLevel": { "type": "number", "format": "double", "x-nullable": true }, "pinterestAccount": { "additionalProperties": true, "x-nullable": true }, "profanityLevel": { "type": "number", "format": "double", "x-nullable": true }, "publicUserSummary": { "type": "boolean" }, "talentManagers": { "items": { "properties": { "lastName": { "type": "string", "x-nullable": true }, "firstName": { "type": "string", "x-nullable": true }, "email": { "type": "string" } }, "type": "object" }, "type": "array" }, "topics": { "items": { "type": "string" }, "type": "array" }, "twitterAccount": { "additionalProperties": true, "x-nullable": true }, "violenceLevel": { "type": "number", "format": "double", "x-nullable": true }, "youtubeChannel": { "additionalProperties": true, "x-nullable": true }, "snapchatAccount": { "additionalProperties": true, "x-nullable": true }, "facebookProfile": { "additionalProperties": true, "x-nullable": true } }, "type": "object", "additionalProperties": false }, "RetrieveGlobalUserElasticsearchDocumentsRequestBody": { "properties": { "facebookProfileIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "instagramProfileIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "membershipIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "options": { "properties": { "index": { "type": "string" } }, "type": "object" } }, "type": "object", "additionalProperties": false }, "EmailSmtpDTO": { "properties": { "id": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "fromEmail": { "type": "string" }, "fromName": { "type": "string" } }, "required": [ "id", "communityId", "fromEmail", "fromName" ], "type": "object", "additionalProperties": false }, "GetEmailSettingsResponse": { "properties": { "isMember": { "type": "boolean" }, "isSubscribed": { "type": "boolean" }, "isGloballyDeleted": { "type": "boolean" } }, "required": [ "isMember", "isSubscribed", "isGloballyDeleted" ], "type": "object", "additionalProperties": false }, "PostEmailSettingsResponse": { "properties": {}, "type": "object", "additionalProperties": false }, "PostEmailSettingsRequest": { "properties": { "id": { "type": "string" }, "subscribed": { "type": "boolean" } }, "required": [ "id", "subscribed" ], "type": "object", "additionalProperties": false }, "FeatureId": { "type": "string", "enum": [ "", "add_creator_non_root", "add_to_creators_v2", "ai_brand_suitability", "ai_brand_suitability_bulk_reports", "ai_brand_suitability_v02", "ai_brand_suitability_v03", "ai_brand_suitability_internal", "ai_creator_match", "amazon_mavely_integration", "amplify_content", "audience_predominant_city_filter", "background_content_export", "bazaarvoice_ratings_only", "brand_safety", "budget_reference_id_required", "budget_reference_id_required_fulfillment", "campaign_application_embed", "campaign_subscription", "community", "concepts_for_creators", "content_module", "create_content", "creator_refresh_non_root", "creator_tax_collection", "custom_analytics_reporting", "custom_workflow_stages", "export_email", "facebook_cds_v2", "facebook_creator_api", "fraud_risk", "funds_tracking", "global_influencer_performance_data_2", "global_influencer_performance_data", "ig_paid_media", "incentive_advisor_v2", "influence_two_admin", "influence_two_campaign_content", "influence_two_campaign_manage", "influence_two_campaign_performance", "influence_two_campaign_search", "influence_two_campaign_setup", "influence_two_campaign_workflow", "influence_two_campaigns", "influence_two_content", "influence_two_dashboard", "influence_two_incentives", "influence_two_influencers", "influence_two_messages", "influence_two_reports", "influence_two_search_summary", "influence_two_search", "influence_two_settings", "influence_two", "instagram_cds_v2", "instance_branding", "keyword_search_chips", "later_360_reports_shareable_link", "later_cta", "mavely_campaign_experience", "mavely_integration", "mavely_payments", "messages_scheduling", "meta_business_integration", "meta_post_partnerships", "payments_custom_reports", "paypal_payments", "pinterest_cds_v2", "public_campaign_summary", "react_migration", "remove_creator", "reports_module", "reports_audience_demographics", "search_account_type_dropdown", "search_creator_card_grid_view", "search_filter_redesign", "search_later_influencers", "search_non_registered", "search_query_tuning", "search_refactor_query_builder", "search_relevance_tuning", "search_onsocial_relevance", "self_serve_users", "shareable_links", "shopify_discount_creation", "show_search_count", "stripe_international_payments", "stripe_payments", "submit_review", "submit_survey", "threaded_influencer_feedback", "tipalti_payments_usd", "tiktok_paid_media", "use_new_opensearch_index", "webhook_setup", "ytbc_deal_reporting_enabled" ], "x-nullable": false }, "Entitlement": { "properties": { "id": { "type": "number", "format": "double" }, "featureId": { "$ref": "#/definitions/FeatureId" }, "communityId": { "type": "string" }, "featureEnabled": { "type": "boolean" }, "label": { "type": "string" } }, "required": [ "id", "featureId", "communityId", "featureEnabled" ], "type": "object", "additionalProperties": false }, "Entitlements": { "properties": { "data": { "items": { "$ref": "#/definitions/Entitlement" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "UpdateEntitlementFields": { "properties": { "communityId": { "type": "string" }, "label": { "type": "string" }, "featureId": { "$ref": "#/definitions/FeatureId" }, "featureEnabled": { "type": "boolean" } }, "required": [ "featureId", "featureEnabled" ], "type": "object" }, "BulkUpdateEntitlementsResponse": { "properties": { "paymentProvisioning": { "properties": { "failed": { "type": "number", "format": "double" }, "succeeded": { "type": "number", "format": "double" }, "attempted": { "type": "number", "format": "double" } }, "required": [ "failed", "succeeded", "attempted" ], "type": "object", "description": "Present when enabling stripe_payments or mavely_payments triggers payment provider app provisioning." }, "cascaded": { "properties": { "affectedCount": { "type": "number", "format": "double" }, "featureEnabled": { "type": "boolean" }, "featureId": { "$ref": "#/definitions/FeatureId" } }, "required": [ "affectedCount", "featureEnabled", "featureId" ], "type": "object", "description": "Present when the operation triggered a dependent feature flag cascade." }, "affectedCount": { "type": "number", "format": "double", "description": "Number of feature_toggles rows updated by the primary operation." } }, "required": [ "affectedCount" ], "type": "object", "description": "Response from PUT /v1/entitlements/bulk.\n\nAlways includes the count of feature_toggles rows updated. Optionally includes\ncascade info (bazaarvoice/submit_review coupling) and payment provisioning results\n(stripe/mavely) when those side-effects are triggered." }, "EntitlementGroup": { "type": "string", "enum": [ "omni", "mavely", "private_label" ], "x-nullable": false, "description": "Predefined instance groups that the backend can resolve without the frontend sending individual IDs." }, "BulkUpdateEntitlementsRequest": { "properties": { "communityIds": { "items": { "type": "string" }, "type": "array" }, "groups": { "items": { "$ref": "#/definitions/EntitlementGroup" }, "type": "array" }, "allCommunities": { "type": "boolean" }, "featureEnabled": { "type": "boolean" }, "featureId": { "$ref": "#/definitions/FeatureId" } }, "required": [ "featureEnabled", "featureId" ], "type": "object", "description": "Request body for PUT /v1/entitlements/bulk.\n\nExactly one targeting strategy is required:\n- `allCommunities: true` — updates every community (and flips features.default_state).\n- `groups` — backend resolves to matching community IDs (prefix match or hardcoded list).\n- `communityIds` — explicit list of community IDs.\n\n`groups` and `communityIds` can be combined (merged with OR).\n`allCommunities` is exclusive and ignores the other two." }, "InferAttributes_Features_": { "properties": { "featureId": { "type": "string" }, "label": { "type": "string" }, "defaultState": { "type": "object" }, "public": { "type": "object" } }, "type": "object", "description": "Utility type to extract Attributes of a given Model class.\n\nIt returns all instance properties defined in the Model, except:\n- those inherited from Model (intermediate inheritance works),\n- the ones whose type is a function,\n- the ones manually excluded using the second parameter.\n- the ones branded using {@link NonAttribute}\n\nIt cannot detect whether something is a getter or not, you should use the `Excluded`\nparameter to exclude getter & setters from the attribute list." }, "GetFeaturesResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InferAttributes_Features_" }, "type": "array" }, "meta": { "properties": { "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "GetFeatureResponse": { "properties": { "data": { "$ref": "#/definitions/InferAttributes_Features_" } }, "required": [ "data" ], "type": "object" }, "UpdateFeatureResponse": { "properties": { "data": { "$ref": "#/definitions/InferAttributes_Features_" } }, "required": [ "data" ], "type": "object" }, "UpdateFeatureRequest": { "properties": { "public": { "type": "boolean" }, "defaultState": { "type": "boolean" }, "label": { "type": "string" } }, "type": "object" }, "EventLog": { "properties": { "communityId": { "type": "string" }, "occurredAt": { "type": "string", "format": "date-time" }, "invokedBy": { "type": "string" }, "eventType": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "type": "string", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "metadata": { "properties": { "rejectedBriefUpdate": { "type": "boolean" }, "briefVersion": { "type": "number", "format": "double" }, "copiedFromActionGroupId": { "type": "number", "format": "double" } }, "type": "object", "x-nullable": true } }, "required": [ "communityId", "eventType", "resourceType" ], "type": "object", "additionalProperties": false }, "EventLogGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/EventLog" }, "type": "array" }, "meta": { "properties": { "orderBy": { "type": "string" }, "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "type": "object" } }, "required": [ "data", "meta" ], "type": "object" }, "EventLogPostRequestBody": { "properties": { "resourceId": { "type": "number", "format": "double" } }, "required": [ "resourceId" ], "type": "object", "additionalProperties": false }, "DateOrTimestamp": { "type": "object" }, "InstagramAudienceCity": { "properties": { "state": { "type": "string" }, "percentage": { "type": "number", "format": "double" }, "end_time": { "$ref": "#/definitions/DateOrTimestamp" }, "count": { "type": "number", "format": "double" }, "city_state": { "type": "string" }, "city_name": { "type": "string" } }, "type": "object" }, "InstagramAudienceCountry": { "properties": { "percentage": { "type": "number", "format": "double" }, "iso_code": { "type": "string" }, "end_time": { "$ref": "#/definitions/DateOrTimestamp" }, "country_name": { "type": "string" }, "count": { "type": "number", "format": "double" } }, "type": "object" }, "InstagramAudienceLocale": { "properties": { "percentage": { "type": "number", "format": "double" }, "locale_code": { "type": "string" }, "end_time": { "$ref": "#/definitions/DateOrTimestamp" }, "count": { "type": "number", "format": "double" } }, "type": "object" }, "InstagramAudience": { "properties": { "predominant_country": { "type": "string" }, "predominant_city": { "type": "string" }, "predominant_age_range": { "type": "string" }, "locales": { "items": { "$ref": "#/definitions/InstagramAudienceLocale" }, "type": "array" }, "gender_percentages": { "properties": { "F": { "type": "number", "format": "double" }, "M": { "type": "number", "format": "double" }, "U": { "type": "number", "format": "double" } }, "type": "object" }, "countries": { "items": { "$ref": "#/definitions/InstagramAudienceCountry" }, "type": "array" }, "cities": { "items": { "$ref": "#/definitions/InstagramAudienceCity" }, "type": "array" }, "age_percentages": { "properties": { "65+": { "type": "number", "format": "double" }, "55-64": { "type": "number", "format": "double" }, "45-54": { "type": "number", "format": "double" }, "35-44": { "type": "number", "format": "double" }, "25-34": { "type": "number", "format": "double" }, "18-24": { "type": "number", "format": "double" }, "13-17": { "type": "number", "format": "double" } }, "type": "object" } }, "type": "object" }, "CreatorOptInInstagram": { "properties": { "website": { "type": "string" }, "source_detail": { "type": "string" }, "profile_type": { "type": "string", "description": "TODO: Redefine 'profile_type' as an enumeration: 'BUSINESS' | 'MEDIA_CREATOR' | 'PERSONAL'\nBasic Display API: https://developers.facebook.com/docs/instagram-basic-display-api/reference/user#fields\nGraph API: https://developers.facebook.com/docs/instagram-api/reference/ig-user#fields" }, "profile_picture": { "type": "string" }, "media_count": { "type": "number", "format": "double" }, "is_private": { "type": "boolean" }, "is_female_percentage": { "type": "number", "format": "double" }, "is_business": { "type": "boolean" }, "instagram_external_id": { "type": "string", "description": "ID generated by Instagram Graph API.\nAs of December 2023, Later and Mavrck use API v12.0, and ID is not app-scoped." }, "handle": { "type": "string" }, "full_name": { "type": "string" }, "following_count": { "type": "number", "format": "double" }, "followers_count": { "type": "number", "format": "double" }, "derived_language": { "type": "string" }, "bio": { "type": "string" }, "audience": { "$ref": "#/definitions/InstagramAudience" } }, "required": [ "instagram_external_id", "handle" ], "type": "object", "description": "Represents a Professional Instagram account.\nProfessional accounts include Business and Creator accounts.\nPersonal accounts are not yet supported." }, "CreatorOptInFacebook": { "properties": { "verified": { "type": "boolean" }, "timezone": { "type": "string" }, "state": { "type": "string" }, "reach": { "type": "number", "format": "double" }, "profile_url": { "type": "string" }, "profile_type": { "type": "string" }, "picture": { "type": "string" }, "phone": { "type": "string" }, "personal_blog_url": { "type": "string" }, "location": { "type": "string" }, "locale": { "type": "string" }, "likes_count": { "type": "number", "format": "double" }, "last_name": { "type": "string" }, "handle": { "type": "string" }, "gender": { "type": "string" }, "full_name": { "type": "string" }, "friend_count": { "type": "string" }, "following_count": { "type": "number", "format": "double" }, "follower_count": { "type": "number", "format": "double" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "currency": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "category": { "type": "string" }, "birthday": { "$ref": "#/definitions/DateOrTimestamp" }, "authentic_public_figure": { "type": "boolean" } }, "required": [ "profile_url" ], "type": "object" }, "CreatorOptInPinterest": { "properties": { "username": { "type": "string" }, "profile_picture": { "type": "string" }, "pinterest_external_id": { "type": "string" }, "pins_count": { "type": "number", "format": "double" }, "monthly_viewers": { "type": "number", "format": "double" }, "last_name": { "type": "string" }, "following_count": { "type": "number", "format": "double" }, "followers_count": { "type": "number", "format": "double" }, "first_name": { "type": "string" }, "engagement_rate": { "type": "number", "format": "double" }, "boards_count": { "type": "number", "format": "double" }, "bio": { "type": "string" }, "average_engagements": { "type": "number", "format": "double" }, "account_created_at": { "$ref": "#/definitions/DateOrTimestamp" } }, "required": [ "username" ], "type": "object" }, "CreatorOptInTikTok": { "properties": { "creatorId": { "type": "string" }, "status": { "type": "string", "enum": [ "IN", "INVALID", "INVITED", "NOT_IN" ], "x-nullable": false }, "profile_image": { "type": "string" }, "is_active": { "type": "boolean" }, "handle_name": { "type": "string" }, "followers_count": { "type": "number", "format": "double" }, "display_name": { "type": "string" }, "audience": { "properties": { "usage": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "usage": { "type": "string" } }, "type": "object" }, "type": "array" }, "locales": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "locale_code": { "type": "string" } }, "type": "object" }, "type": "array" }, "genders": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "gender": { "type": "string" } }, "type": "object" }, "type": "array" }, "device": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "device_name": { "type": "string" } }, "type": "object" }, "type": "array" }, "countries": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "country_code": { "type": "string" } }, "type": "object" }, "type": "array" }, "ages": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "age": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } }, "required": [ "profile_image", "handle_name" ], "type": "object" }, "CreatorOptInTwitter": { "properties": { "verified": { "type": "boolean" }, "utc_offset": { "type": "number", "format": "double" }, "twitter_external_id": { "type": "string" }, "time_zone": { "type": "string" }, "protected": { "type": "boolean" }, "profile_picture": { "type": "string" }, "location": { "type": "string" }, "listed_count": { "type": "number", "format": "double" }, "lang": { "type": "string" }, "handle": { "type": "string" }, "geo_enabled": { "type": "boolean" }, "full_name": { "type": "string" }, "following_count": { "type": "number", "format": "double" }, "followers_count": { "type": "number", "format": "double" }, "engagement_rate": { "type": "number", "format": "double" }, "description": { "type": "string" }, "average_retweets": { "type": "number", "format": "double" }, "average_favorites": { "type": "number", "format": "double" }, "average_engagements": { "type": "number", "format": "double" }, "account_created_at": { "type": "string" } }, "required": [ "twitter_external_id", "handle" ], "type": "object" }, "CreatorOptInRequestSocialMedias": { "properties": { "twitter": { "$ref": "#/definitions/CreatorOptInTwitter" }, "tiktok": { "$ref": "#/definitions/CreatorOptInTikTok" }, "pinterest": { "$ref": "#/definitions/CreatorOptInPinterest" }, "facebook": { "$ref": "#/definitions/CreatorOptInFacebook" }, "instagram": { "$ref": "#/definitions/CreatorOptInInstagram" } }, "type": "object" }, "CreatorOptInRequest": { "properties": { "social_medias": { "$ref": "#/definitions/CreatorOptInRequestSocialMedias" } }, "type": "object", "additionalProperties": false }, "ExternalCampaignApplicationRequest": { "properties": { "quote": { "type": "number", "format": "double", "minimum": 0 }, "payment_recipient_uuid": { "type": "string" }, "mavely_profile_id": { "type": "string" }, "influencer": { "$ref": "#/definitions/CreatorOptInRequest" }, "creator_profile_id": { "type": "string" }, "concept": { "type": "string", "minLength": 1, "maxLength": 10000 }, "application_answers": { "$ref": "#/definitions/QuestionAnswers" }, "action_group_id": { "type": "integer", "format": "int32" } }, "required": [ "creator_profile_id", "action_group_id" ], "type": "object" }, "CreateExternalClientResponse": { "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "clientId", "clientSecret", "name", "createdAt" ], "type": "object", "additionalProperties": false }, "CreateExternalClientBody": { "description": "Request body for creating an external client", "properties": { "name": { "type": "string" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "required": [ "name" ], "type": "object", "additionalProperties": false }, "RegenerateSecretResponse": { "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "regeneratedAt": { "type": "string", "format": "date-time" } }, "required": [ "clientId", "clientSecret", "regeneratedAt" ], "type": "object", "additionalProperties": false }, "EmptySuccessResponse": { "description": "Empty success response", "properties": {}, "type": "object", "additionalProperties": false }, "AssociateInstancesBody": { "description": "Request body for associating instances", "properties": { "instanceIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "instanceIds" ], "type": "object", "additionalProperties": false }, "ClientWithInstances": { "description": "Client with active and inactive instances", "properties": { "clientId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "connectedInstances": { "items": { "type": "string" }, "type": "array" }, "disconnectedInstances": { "items": { "type": "string" }, "type": "array" } }, "required": [ "clientId", "name", "createdAt", "updatedAt", "deletedAt", "connectedInstances", "disconnectedInstances" ], "type": "object", "additionalProperties": false }, "GetAllClientsResponse": { "description": "Paginated response for getting all clients with instances", "properties": { "clients": { "items": { "$ref": "#/definitions/ClientWithInstances" }, "type": "array" }, "pagination": { "properties": { "totalPages": { "type": "number", "format": "double" }, "pageSize": { "type": "number", "format": "double" }, "page": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" } }, "required": [ "totalPages", "pageSize", "page", "total" ], "type": "object" } }, "required": [ "clients", "pagination" ], "type": "object", "additionalProperties": false }, "BaseTransferStatusRecord": { "properties": { "id": { "type": "number", "format": "double" }, "transferId": { "type": "number", "format": "double" }, "providerStatusCode": { "type": "string" }, "providerStatusMessage": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "transferId", "providerStatusCode", "providerStatusMessage", "createdAt", "updatedAt" ], "type": "object", "additionalProperties": false }, "MavelyTransferStatus": { "type": "string", "enum": [ "INITIATED", "PAYMENT_APPROVED", "PAYMENT_CANCELED", "SUCCESS", "FAILED" ], "x-nullable": false }, "MavelyTransferStatusRecord": { "type": "object", "properties": { "id": { "type": "number", "format": "double" }, "transferId": { "type": "number", "format": "double" }, "providerStatusCode": { "type": "string" }, "providerStatusMessage": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "MavelyTransferWithStatusHistoryResponse": { "properties": { "instanceId": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" }, "statusHistory": { "items": { "$ref": "#/definitions/MavelyTransferStatusRecord" }, "type": "array" } }, "required": [ "instanceId", "actionGroupId", "statusHistory" ], "type": "object" }, "TipaltiProviderStatus": { "type": "string", "enum": [ "ACTIVE", "BLOCKED", "SUSPENDED", "BLOCKED_BY_TIPALTI", "INTERNAL_VALUE" ], "x-nullable": false }, "PayableEntity": { "properties": { "id": { "type": "number", "format": "double" }, "cashPaymentAppId": { "type": "number", "format": "double" }, "providerStatus": { "$ref": "#/definitions/TipaltiProviderStatus" }, "isPayable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "TIPALTI" ], "x-nullable": false } }, "required": [ "id", "cashPaymentAppId", "providerStatus", "isPayable", "isActive", "provider" ], "type": "object", "additionalProperties": false }, "PaymentRecipientView": { "properties": { "id": { "type": "number", "format": "double" }, "uuid": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true }, "companyName": { "type": "string", "x-nullable": true }, "country": { "type": "string", "x-nullable": true }, "isActive": { "type": "boolean" }, "payableEntities": { "items": { "$ref": "#/definitions/PayableEntity" }, "type": "array" } }, "required": [ "id", "uuid", "email", "firstName", "lastName", "companyName", "country", "isActive", "payableEntities" ], "type": "object", "additionalProperties": false }, "PaymentRecipientCreateRequest": { "properties": { "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "companyName": { "type": "string" }, "country": { "type": "string" }, "include": { "items": { "type": "string", "enum": [ "TIPALTI_PAYEE" ], "x-nullable": false }, "type": "array" } }, "required": [ "email" ], "type": "object", "additionalProperties": false }, "OnboardingReminderRequestBody": { "description": "Domain types for payment-recipient creator notifications (onboarding reminder + payment\nconfirmation). These mirror the Stripe notification payloads but are provider-agnostic: the\ncreator only ever sees generic \"payment information\" copy, while the code refers to the\ninternal \"payment recipient\" concept.", "properties": { "globalUserId": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" } }, "required": [ "globalUserId", "actionGroupId" ], "type": "object", "additionalProperties": false }, "TipaltiPayeeIframeUrlResponse": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "VerificationCodeResponse": { "properties": { "code": { "type": "string" } }, "required": [ "code" ], "type": "object", "additionalProperties": false }, "VerificationCodeRequest": { "properties": { "email": { "type": "string" }, "clientId": { "type": "string" } }, "required": [ "email", "clientId" ], "type": "object", "additionalProperties": false }, "VerificationConfirmRequest": { "properties": { "email": { "type": "string" }, "clientId": { "type": "string" }, "code": { "type": "string" } }, "required": [ "email", "clientId", "code" ], "type": "object", "additionalProperties": false }, "PaymentRecipientLinksMutationResult": { "description": "Result of a bulk clear/propagate. `memberships` is how many campaign\nmemberships the operation matched (clearable set for clear, active set for\npropagate); `affected` is how many link rows actually changed.", "properties": { "memberships": { "type": "number", "format": "double" }, "affected": { "type": "number", "format": "double" } }, "required": [ "memberships", "affected" ], "type": "object", "additionalProperties": false }, "ClearPaymentRecipientLinksRequest": { "description": "Account-level disconnect. latergram expands a Later Social account to its\ncreators' CDS creator_profile_ids and calls this to clear the link from every\nactive campaign membership. SAPI resolves each creator_profile_id to a\nglobal_user_id; a profile that can't be resolved has no memberships to touch\nand is skipped.\n\npayment_recipient_uuid is optional: when omitted, every live link on the\npayable memberships is cleared (a full account disconnect). When present, only\nlinks to that specific recipient are cleared — used by the propagate worker's\ncompensating clear to undo links it created for a recipient that was severed\nmid-flight, without touching links to any other recipient.", "properties": { "creator_profile_ids": { "items": { "type": "string" }, "type": "array" }, "payment_recipient_uuid": { "type": "string" } }, "required": [ "creator_profile_ids" ], "type": "object", "additionalProperties": false }, "PropagatePaymentRecipientLinksRequest": { "description": "Account-level reconnect. Re-links every active campaign membership of the given\ncreators to the newly connected recipient.", "properties": { "creator_profile_ids": { "items": { "type": "string" }, "type": "array" }, "payment_recipient_uuid": { "type": "string" } }, "required": [ "creator_profile_ids", "payment_recipient_uuid" ], "type": "object", "additionalProperties": false }, "FailedInstanceForEnablingStripeProvider": { "properties": { "instanceId": { "type": "string" }, "error": { "type": "string" } }, "required": [ "instanceId", "error" ], "type": "object", "additionalProperties": false }, "ConfigureStripeProviderAppToInstanceResponse": { "properties": { "failedInstances": { "items": { "$ref": "#/definitions/FailedInstanceForEnablingStripeProvider" }, "type": "array" }, "succesfulInstances": { "items": { "type": "string" }, "type": "array" } }, "required": [ "failedInstances", "succesfulInstances" ], "type": "object", "additionalProperties": false }, "ConfigureStripeProviderAppToInstanceBody": { "properties": { "instanceIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "instanceIds" ], "type": "object", "additionalProperties": false }, "StripeAccountStatusResponse": { "properties": { "globalUserId": { "type": "number", "format": "double" }, "onboardingStatus": { "$ref": "#/definitions/StripeOnboardingStatus" }, "country": { "type": "string", "x-nullable": true }, "currencyCode": { "type": "object" } }, "required": [ "globalUserId", "onboardingStatus" ], "type": "object", "additionalProperties": false }, "StripeExchangeRate": { "properties": { "id": { "$ref": "#/definitions/StripeSupportedCurrencyCodes" }, "rates": { "properties": {}, "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } }, "required": [ "id", "rates" ], "type": "object", "additionalProperties": false }, "StripeTransferStatus": { "type": "string", "enum": [ "SUCCESS", "FAILED", "REVERSED", "TRANSFER_SUCCESS", "PAYOUT_PENDING", "PAYOUT_FAILED" ], "x-nullable": false }, "StripeTransferStatusRecord": { "type": "object", "properties": { "id": { "type": "number", "format": "double" }, "transferId": { "type": "number", "format": "double" }, "providerStatusCode": { "type": "string" }, "providerStatusMessage": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "StripeConnectAccountInfo": { "properties": { "name": { "type": "string" }, "email": { "type": "string" } }, "required": [ "name", "email" ], "type": "object", "additionalProperties": false }, "StripeTransferWithStatusHistoryResponse": { "properties": { "instanceId": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" }, "stripeConnectAccount": { "$ref": "#/definitions/StripeConnectAccountInfo" }, "statusHistory": { "items": { "$ref": "#/definitions/StripeTransferStatusRecord" }, "type": "array" } }, "required": [ "instanceId", "actionGroupId", "statusHistory" ], "type": "object" }, "TipaltiPayeeView": { "description": "Mirrors the payment-service TipaltiPayeeView returned by GET /tipalti-payees/{refCode}.", "properties": { "id": { "type": "number", "format": "double" }, "cashPaymentAppId": { "type": "number", "format": "double" }, "tipaltiRefCode": { "type": "string" }, "providerId": { "type": "string", "x-nullable": true }, "email": { "type": "string" }, "currency": { "type": "string", "x-nullable": true }, "providerStatus": { "$ref": "#/definitions/TipaltiProviderStatus" }, "isPayable": { "type": "boolean" }, "isActive": { "type": "boolean" }, "provider": { "type": "string", "enum": [ "TIPALTI" ], "x-nullable": false } }, "required": [ "id", "cashPaymentAppId", "tipaltiRefCode", "providerId", "email", "currency", "providerStatus", "isPayable", "isActive", "provider" ], "type": "object", "additionalProperties": false }, "TipaltiPayeeResponse": { "properties": { "payee": { "type": "object" } }, "required": [ "payee" ], "type": "object", "additionalProperties": false }, "TipaltiPaymentStatus": { "type": "string", "enum": [ "INITIATED", "SUBMITTING", "SUBMITTED", "SUBMITTED_UNCONFIRMED", "PAYMENT_APPROVED", "PROCESSING", "SUCCESS", "FAILED", "PAYMENT_CANCELED", "VOIDED", "DEFERRED" ], "x-nullable": false }, "TipaltiPaymentStatusHistoryItem": { "type": "object", "properties": { "id": { "type": "number", "format": "double" }, "transferId": { "type": "number", "format": "double" }, "providerStatusCode": { "type": "string" }, "providerStatusMessage": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } } }, "CreateTipaltiTransferResponse": { "description": "Mirrors the payment-service TipaltiPaymentView returned by POST /tipalti-payments/register.", "properties": { "id": { "type": "number", "format": "double" }, "tipaltiPayeeId": { "type": "number", "format": "double" }, "refCode": { "type": "string" }, "tipaltiPaymentId": { "type": "string", "x-nullable": true }, "tipaltiBatchId": { "type": "string", "x-nullable": true }, "amount": { "type": "number", "format": "double" }, "amountCurrencyCode": { "$ref": "#/definitions/TipaltiSupportedCurrencyCodes" }, "paymentAmount": { "type": "number", "format": "double", "x-nullable": true }, "paymentAmountCurrency": { "type": "string", "x-nullable": true }, "exchangeRate": { "type": "number", "format": "double", "x-nullable": true }, "actionGroupId": { "type": "number", "format": "double" }, "instanceId": { "type": "string" }, "rewardWinId": { "type": "number", "format": "double", "x-nullable": true }, "latestStatus": { "$ref": "#/definitions/TipaltiPaymentStatus" }, "statusHistory": { "items": { "$ref": "#/definitions/TipaltiPaymentStatusHistoryItem" }, "type": "array" } }, "required": [ "id", "tipaltiPayeeId", "refCode", "tipaltiPaymentId", "tipaltiBatchId", "amount", "amountCurrencyCode", "paymentAmount", "paymentAmountCurrency", "exchangeRate", "actionGroupId", "instanceId", "rewardWinId", "latestStatus", "statusHistory" ], "type": "object", "additionalProperties": false }, "TipaltiTransferWithStatusHistoryResponse": { "$ref": "#/definitions/CreateTipaltiTransferResponse", "description": "GET /v1/tipalti/transfers/{rewardWinId} — the most recent attempt for a reward win with its\nstatus history. Same shape as the create response (payment-service TipaltiPaymentView)." }, "Pick_EmailTemplate.Exclude_keyofEmailTemplate.closing-or-customerServiceMessage-or-etid__": { "properties": { "name": { "type": "string" }, "fromName": { "type": "string" }, "subject": { "type": "string" }, "headerImage": { "type": "string" }, "headerImageAltText": { "type": "string" }, "accentColor": { "type": "string" }, "messageBody": { "type": "string" } }, "required": [ "name", "fromName", "subject", "headerImage", "headerImageAltText", "accentColor", "messageBody" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_EmailTemplate.closing-or-customerServiceMessage-or-etid_": { "$ref": "#/definitions/Pick_EmailTemplate.Exclude_keyofEmailTemplate.closing-or-customerServiceMessage-or-etid__", "description": "Construct a type with the properties of T except for those in type K." }, "EmailTemplateResponse": { "type": "object", "properties": {} }, "Templates": { "properties": { "data": { "items": { "$ref": "#/definitions/EmailTemplateResponse" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "Balance": { "properties": { "balance": { "type": "number", "format": "double" } }, "required": [ "balance" ], "type": "object", "additionalProperties": false }, "GiftCardOption": { "properties": { "brandName": { "type": "string" }, "currencyCode": { "type": "string" }, "description": { "type": "string" }, "disclaimer": { "type": "string" }, "externalId": { "type": "number", "format": "double" }, "faceValue": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "image": { "type": "string" }, "maxValue": { "type": "number", "format": "double" }, "minValue": { "type": "number", "format": "double" }, "thumbnail": { "type": "string" }, "valueType": { "type": "string" } }, "required": [ "brandName", "currencyCode", "description", "disclaimer", "externalId", "faceValue", "id", "image", "maxValue", "minValue", "thumbnail", "valueType" ], "type": "object", "additionalProperties": false }, "ResponseBody_GiftCardOption-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/GiftCardOption" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "GraphDatapoint": { "properties": { "value": { "type": "number", "format": "double" }, "display": { "type": "string" } }, "required": [ "value", "display" ], "type": "object" }, "DemographicsGraph": { "properties": { "data": { "items": { "$ref": "#/definitions/GraphDatapoint" }, "type": "array" }, "id": { "type": "string" } }, "required": [ "data", "id" ], "type": "object" }, "DemographicsGraphsResponse": { "properties": { "graphs": { "items": { "$ref": "#/definitions/DemographicsGraph" }, "type": "array" } }, "required": [ "graphs" ], "type": "object", "description": "*\nDemographics Pro Graphs" }, "ActionGroupIncentivePutBody": { "properties": { "id": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" }, "unlockEvent": { "$ref": "#/definitions/IncentiveUnlockEvent" } }, "required": [ "actionGroupId" ], "type": "object", "additionalProperties": false }, "TermsAndConditionsTemplate": { "properties": { "customParams": { "items": { "type": "string" }, "type": "array" }, "template": { "type": "string" } }, "required": [ "customParams", "template" ], "type": "object" }, "IncentiveUnlockPostBody": { "properties": { "claims": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "IncentivesGetResponse": { "properties": { "meta": { "properties": { "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/Incentive" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object", "additionalProperties": false }, "IncentiveGetResponse": { "properties": { "id": { "type": "number", "format": "double" }, "incentiveTitle": { "type": "string" }, "incentiveStatus": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "type": { "type": "string" }, "rewardWinType": { "type": "string" }, "multipleClaims": { "type": "boolean", "enum": [ false ], "x-nullable": false }, "rewardId": { "type": "string" }, "winnersSelectedCount": { "type": "number", "format": "double" }, "disqualifiedWinnersCount": { "type": "number", "format": "double" }, "claimedIncentivesInfluencerCount": { "type": "number", "format": "double" }, "claimedIncentivesCount": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" }, "actionGroupStatus": { "type": "string" }, "endDate": { "type": "string", "x-nullable": true }, "startDate": { "type": "string", "x-nullable": true }, "unlockType": { "type": "string" }, "approximateRetailValue": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "costCurrencyCode": { "type": "string" }, "valueCurrencyCode": { "type": "string" }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode", "description": "Currency code used for all tiered bonus amounts. Required when `bonusTiers` is non-empty." }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true, "description": "Tiered bonus payout ladder. Must be sorted, contiguous, contain at most 5 tiers, and end with one `OPEN_ENDED` tier." }, "totalDynamicPromoCodes": { "type": "number", "format": "double" }, "claimedDynamicPromoCodes": { "type": "number", "format": "double" }, "unlockEvent": { "$ref": "#/definitions/IncentiveUnlockEvent" }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "cashPaymentAppProvider": { "type": "string", "x-nullable": true }, "giftCardEmailTemplateId": { "type": "string", "x-nullable": true }, "giftCardOptionId": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "id", "incentiveTitle", "quantity", "type", "rewardWinType", "multipleClaims", "rewardId", "winnersSelectedCount", "disqualifiedWinnersCount", "claimedIncentivesInfluencerCount", "claimedIncentivesCount", "actionGroupId", "actionGroupStatus", "unlockType", "approximateRetailValue", "cost", "costCurrencyCode", "valueCurrencyCode", "totalDynamicPromoCodes", "claimedDynamicPromoCodes", "unlockEvent" ], "type": "object", "additionalProperties": false }, "IncentiveURI": { "properties": { "id": { "type": "number", "format": "double" } }, "required": [ "id" ], "type": "object", "additionalProperties": false }, "ShopifyDiscountObject": { "properties": { "prefix": { "type": "string" }, "startsAt": { "type": "string", "x-nullable": true }, "endsAt": { "type": "string", "x-nullable": true }, "entitledProductIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "entitledCollectionIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "couponActivation": { "type": "string" } }, "required": [ "prefix" ], "type": "object", "additionalProperties": false }, "CreateIncentivePostBody": { "properties": { "incentiveTitle": { "type": "string" }, "incentiveStatus": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "image": { "type": "string" }, "multipleClaims": { "type": "boolean" }, "termsAndConditions": { "$ref": "#/definitions/IncentiveTermsAndConditions" }, "dynamicPromoCodesToAdd": { "items": { "type": "string" }, "type": "array" }, "rewardWinType": { "$ref": "#/definitions/DBRewardWinType" }, "approximateRetailValue": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "valueCurrencyCode": { "$ref": "#/definitions/MavrckSupportedCurrencies" }, "type": { "type": "string" }, "unlockEvent": { "$ref": "#/definitions/IncentiveUnlockEvent" }, "unlockType": { "type": "string" }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "cashPaymentAppProvider": { "type": "string", "x-nullable": true }, "giftCardEmailTemplateId": { "type": "string", "x-nullable": true }, "giftCardOptionId": { "type": "number", "format": "double", "x-nullable": true }, "costCurrencyCode": { "type": "object" }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode", "description": "Currency code used for all tiered bonus amounts. Required when `bonusTiers` is non-empty." }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true, "description": "Tiered bonus payout ladder. Must be sorted, contiguous, contain at most 5 tiers, and end with one `OPEN_ENDED` tier." }, "shopify": { "type": "object" } }, "required": [ "incentiveTitle", "quantity" ], "type": "object", "additionalProperties": false }, "UpdateIncentivePutBody": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "actionGroupStatus": { "type": "string" }, "approximateRetailValue": { "type": "number", "format": "double" }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "claimedDynamicPromoCodes": { "type": "number", "format": "double" }, "claimedIncentivesCount": { "type": "number", "format": "double" }, "claimedIncentivesInfluencerCount": { "type": "number", "format": "double" }, "cost": { "type": "number", "format": "double" }, "disqualifiedWinnersCount": { "type": "number", "format": "double" }, "incentiveTitle": { "type": "string" }, "incentiveStatus": { "type": "string" }, "multipleClaims": { "type": "boolean" }, "quantity": { "type": "number", "format": "double" }, "rewardId": { "type": "string" }, "rewardWinType": { "type": "string" }, "totalDynamicPromoCodes": { "type": "number", "format": "double" }, "type": { "type": "string" }, "unlockEvent": { "$ref": "#/definitions/IncentiveUnlockEvent" }, "unlockType": { "type": "string" }, "winnersSelectedCount": { "type": "number", "format": "double" }, "endDate": { "type": "string", "x-nullable": true }, "startDate": { "type": "string", "x-nullable": true }, "costCurrencyCode": { "type": "string" }, "valueCurrencyCode": { "type": "string" }, "dynamicPromoCodesList": { "type": "string" }, "dynamicPromoCodesToAdd": { "items": { "type": "string" }, "type": "array" }, "cashPaymentAppProvider": { "type": "string", "x-nullable": true }, "giftCardEmailTemplateId": { "type": "string", "x-nullable": true }, "giftCardOptionId": { "type": "number", "format": "double", "x-nullable": true }, "shopify": { "type": "object" }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode", "description": "Currency code used for all tiered bonus amounts. When updated, `bonusTiers` must also be provided." }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true, "description": "Tiered bonus payout ladder. Must be sorted, contiguous, contain at most 5 tiers, and end with one `OPEN_ENDED` tier." } }, "required": [ "valueCurrencyCode" ], "type": "object", "additionalProperties": false }, "DBInfluencerAgreementHistoryFields": { "properties": { "updateReason": { "type": "string", "enum": [ "GLOBAL_USER_MERGE", null ], "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "influencerContract": { "additionalProperties": true }, "influencerContractLevel": { "type": "string", "enum": [ "CAMPAIGN", "INSTANCE" ], "x-nullable": false }, "campaignTermsOfUseUrl": { "type": "string", "x-nullable": true }, "termsOfUseUrl": { "type": "string", "x-nullable": true }, "influencerAgreementUrl": { "type": "string", "x-nullable": true }, "name": { "type": "string" }, "communityId": { "type": "string" }, "actionGroupId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" } }, "required": [ "updateReason", "updatedAt", "createdAt", "influencerContract", "influencerContractLevel", "campaignTermsOfUseUrl", "termsOfUseUrl", "influencerAgreementUrl", "name", "communityId", "actionGroupId", "globalUserId", "id" ], "type": "object" }, "CreateInfluencerAgreementHistoryFieldsBody": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "actionGroupId", "communityId" ], "type": "object", "additionalProperties": false }, "InfluencerCampaignBase": { "type": "object", "properties": { "accentColor": { "type": "string" }, "buttonColor": { "type": "string" }, "id": { "type": "number", "format": "double" }, "logo": { "type": "string" }, "associatedWithCampaign": { "type": "boolean" }, "name": { "type": "string" } } }, "InfluencerCampaignHistory": { "type": "object", "properties": {} }, "InfluencerCampaignHistoryGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerCampaignHistory" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "Pick_InfluencerCampaign.Exclude_keyofInfluencerCampaign.productReviewDeliverables__": { "properties": { "listMemberId": { "type": "number", "format": "double" }, "applicationTitle": { "type": "string" }, "statusSlug": { "$ref": "#/definitions/InfluencerCampaignStatusSlug" } }, "required": [ "listMemberId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_InfluencerCampaign.productReviewDeliverables_": { "$ref": "#/definitions/Pick_InfluencerCampaign.Exclude_keyofInfluencerCampaign.productReviewDeliverables__", "description": "Construct a type with the properties of T except for those in type K." }, "LegacyInfluencerCampaignProductReview": { "properties": { "imageUrl": { "type": "string" }, "reviewId": { "type": "string" } }, "type": "object" }, "LegacyInfluencerCampaign": { "type": "object", "properties": {} }, "LimitedCampaign": { "properties": { "title": { "type": "string", "x-nullable": true }, "termsOfServiceLink": { "type": "string" }, "status": { "type": "string" }, "startDate": { "type": "string", "format": "date-time" }, "shareWithLater": { "type": "boolean" }, "requireYoutube": { "type": "boolean" }, "requireTwitter": { "type": "boolean" }, "requireTiktok": { "type": "boolean", "x-nullable": true }, "requireStreetAddress": { "type": "boolean" }, "requireQuote": { "type": "boolean" }, "requiredToViewAllContracts": { "type": "boolean" }, "requirePrivacyPolicy": { "type": "boolean" }, "requirePinterest": { "type": "boolean" }, "requirePhoneNumber": { "type": "boolean" }, "requireMavely": { "type": "boolean", "x-nullable": true }, "requireInstagram": { "type": "boolean" }, "requireFacebook": { "type": "boolean" }, "requireEthnicityQuestion": { "type": "boolean" }, "requireConcept": { "type": "boolean" }, "requestBrandedContentPermission": { "type": "boolean" }, "publicSummary": { "type": "string", "x-nullable": true }, "lastPolledAt": { "type": "string", "format": "date-time", "x-nullable": true }, "influencerAgreement": { "properties": { "url": { "type": "string" }, "label": { "type": "string" } }, "required": [ "url", "label" ], "type": "object" }, "image": { "type": "string", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "description": { "type": "string", "x-nullable": true }, "contentDueDate": { "type": "string", "format": "date-time" }, "brief": { "type": "string" }, "brandName": { "type": "string" }, "applicationUrl": { "type": "string" }, "applicationStatus": { "type": "string", "enum": [ "OPEN", "CLOSED" ], "x-nullable": false }, "applicationQuestions": { "items": { "$ref": "#/definitions/LimitedCampaignApplicationQuestion" }, "type": "array" } }, "required": [ "title", "status", "shareWithLater", "requireYoutube", "requireTwitter", "requireTiktok", "requireStreetAddress", "requireQuote", "requiredToViewAllContracts", "requirePrivacyPolicy", "requirePinterest", "requirePhoneNumber", "requireInstagram", "requireFacebook", "requireEthnicityQuestion", "requireConcept", "requestBrandedContentPermission", "image", "id", "description", "brandName", "applicationUrl", "applicationStatus", "applicationQuestions" ], "type": "object" }, "LegacyInfluencerCampaignGetResponse": { "type": "object" }, "InfluencerLinks": { "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "url": { "type": "string" } }, "required": [ "key", "label", "url" ], "type": "object", "additionalProperties": false }, "GetInfluencerLinksResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/InfluencerLinks" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "InfluencerReviewDeliverablePostBody": { "properties": { "count": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" } }, "required": [ "count", "listId" ], "type": "object", "additionalProperties": false }, "GetInfluencerPerformanceListData": { "properties": { "zip": { "type": "string" }, "currentPointsBalance": { "type": "number", "format": "double" }, "totalPoints": { "type": "number", "format": "double" }, "street": { "type": "string" }, "state": { "type": "string" }, "profilePicture": { "type": "string" }, "posts": { "type": "number", "format": "double" }, "phone": { "type": "string" }, "membershipId": { "type": "number", "format": "double" }, "lastName": { "type": "string" }, "impressions": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "gender": { "type": "string" }, "fullName": { "type": "string" }, "firstName": { "type": "string" }, "engagementsPerPost": { "type": "number", "format": "double" }, "engagements": { "type": "number", "format": "double" }, "email": { "type": "string" }, "country": { "type": "string" }, "city": { "type": "string" }, "birthday": { "type": "string" }, "apt": { "type": "string" }, "age": { "type": "number", "format": "double" }, "activations": { "type": "number", "format": "double" } }, "type": "object" }, "GetInfluencerPerformanceListResponse": { "properties": { "meta": { "properties": { "offset": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "totalCount" ], "type": "object" }, "data": { "items": { "$ref": "#/definitions/GetInfluencerPerformanceListData" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object" }, "MetaPostPartnershipRequestStatus": { "type": "string", "enum": [ "pending", "granted", "denied" ], "x-nullable": false }, "MetaPostPartnershipRequestDto": { "properties": { "id": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/definitions/MetaPostPartnershipRequestStatus" }, "communityId": { "type": "string" }, "activationId": { "type": "number", "format": "double" } }, "required": [ "id", "createdAt", "updatedAt", "status", "communityId", "activationId" ], "type": "object", "additionalProperties": false }, "UpdateInfluencerPostPartnershipRequestRequestBody": { "properties": { "externalSponsorId": { "type": "string" }, "status": { "$ref": "#/definitions/MetaPostPartnershipRequestStatus" } }, "required": [ "status" ], "type": "object" }, "MetaInstagramAccountDto": { "properties": { "name": { "type": "string" }, "handle": { "type": "string" }, "pictureUrl": { "type": "string" }, "externalId": { "type": "string" } }, "required": [ "name", "handle", "pictureUrl", "externalId" ], "type": "object", "additionalProperties": false }, "UpdateInstagramProfilePictureItem": { "properties": { "imageUrl": { "type": "string", "x-nullable": true }, "instagramProfileId": { "type": "number", "format": "double" } }, "required": [ "instagramProfileId" ], "type": "object" }, "UpdateInstagramProfilePictureRequest": { "items": { "$ref": "#/definitions/UpdateInstagramProfilePictureItem" }, "type": "array" }, "LinksGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/Link" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMetadata" } }, "type": "object", "additionalProperties": false }, "LinksPostResponse": { "properties": { "data": { "$ref": "#/definitions/Link" } }, "type": "object", "additionalProperties": false }, "LinkPostRequest": { "properties": { "mavelyProfileId": { "type": "string" }, "specId": { "type": "number", "format": "double" }, "destinationUrl": { "type": "string" }, "title": { "type": "string" }, "provider": { "type": "string" }, "laterInfluenceCampaignName": { "type": "string" } }, "required": [ "mavelyProfileId", "destinationUrl", "title", "provider", "laterInfluenceCampaignName" ], "type": "object", "additionalProperties": false }, "LinkPutRequest": { "properties": { "title": { "type": "string" }, "destinationUrl": { "type": "string" } }, "required": [ "title" ], "type": "object", "additionalProperties": false }, "SpecsGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/Spec" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMetadata" } }, "type": "object", "additionalProperties": false }, "SpecsPostRequest": { "properties": { "destinationUrl": { "type": "string" }, "title": { "type": "string" }, "laterInfluenceCampaignId": { "type": "number", "format": "double" }, "provider": { "type": "string" } }, "required": [ "destinationUrl", "title", "laterInfluenceCampaignId", "provider" ], "type": "object", "additionalProperties": false }, "SpecsPutRequest": { "properties": { "destinationUrl": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object", "additionalProperties": false }, "ListCustomInfluencerStatus": { "properties": { "label": { "type": "string" }, "influencerLabel": { "type": "string" }, "influencerInstructions": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "label", "influencerLabel", "influencerInstructions", "id" ], "type": "object" }, "ResponseBody_ListCustomInfluencerStatus-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/ListCustomInfluencerStatus" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ListCustomInfluencerStatusesResponse": { "properties": { "id": { "type": "object" } }, "type": "object" }, "Pick_ListCustomInfluencerStatus.influencerLabel-or-label_": { "properties": { "label": { "type": "string" }, "influencerLabel": { "type": "string" } }, "required": [ "label", "influencerLabel" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "ListCustomInfluencerStatusPostRequestBody": { "type": "object", "properties": {} }, "ListCustomInfluencerStatusPutRequestBody": { "$ref": "#/definitions/ListCustomInfluencerStatusPostRequestBody" }, "ActionGroupCustomStatusesGetResponse": { "properties": { "meta": { "$ref": "#/definitions/ResponseMetadata" }, "data": { "items": { "$ref": "#/definitions/ListCustomStatus" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "Partial_ListCustomStatus_": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "auxiliaryLabel": { "type": "string" }, "ctaLabel": { "type": "string" }, "custom": { "type": "boolean" }, "disabled": { "type": "boolean" }, "enabled": { "type": "boolean" }, "id": { "type": "number", "format": "double" }, "label": { "type": "string" }, "linkedStages": { "items": { "type": "string" }, "type": "array" }, "phase": { "type": "string" }, "slug": { "type": "string" }, "statusOrder": { "type": "number", "format": "double" }, "templates": { "items": { "$ref": "#/definitions/ConversationTemplate" }, "type": "array" } }, "type": "object", "description": "Make all properties in T optional" }, "ActionGroupCustomStatusDeleteResponse": { "properties": { "operation": { "type": "string" } }, "type": "object" }, "Pick_ListDeliverable.contentType-or-count-or-listId_": { "properties": { "contentType": { "$ref": "#/definitions/NetworkSlug" }, "count": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" } }, "required": [ "contentType", "count", "listId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "TikTokBrandFields": { "properties": { "brandDescription": { "type": "string" }, "brandName": { "type": "string" } }, "type": "object" }, "ListDeliverableRequest": { "type": "object", "properties": {} }, "ListMemberDeliverable": { "properties": { "listMemberId": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "count": { "type": "number", "format": "double" }, "contentTypeName": { "$ref": "#/definitions/NetworkName" }, "contentType": { "$ref": "#/definitions/NetworkSlug" } }, "required": [ "listMemberId", "listId", "id", "count", "contentTypeName", "contentType" ], "type": "object" }, "ListMemberDeliverablePostRequest": { "properties": { "count": { "type": "number", "format": "double" }, "contentType": { "$ref": "#/definitions/NetworkSlug" }, "listId": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" } }, "required": [ "count", "contentType", "listId", "listMemberId" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverableBulkAssignPostResponse": { "properties": { "completed": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "listMemberIds" ], "type": "object" }, "failed": { "items": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "reason": { "type": "string" } }, "required": [ "listMemberIds", "reason" ], "type": "object" }, "type": "array" } }, "required": [ "completed", "failed" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverableBulkAssignPostRequest": { "properties": { "deliverables": { "items": { "properties": { "contentType": { "$ref": "#/definitions/NetworkSlug" }, "count": { "type": "number", "format": "double" } }, "required": [ "contentType", "count" ], "type": "object" }, "type": "array" }, "listId": { "type": "number", "format": "double" }, "queryFilter": { "additionalProperties": true }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "deliverables", "listId" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverableBulkAssignSummaryPostResponse": { "properties": { "summary": { "properties": { "youtube_shorts": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "youtube_video": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "video": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "twitter": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "twitch_stream": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "tiktok": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "snapchat_story": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "pinterest": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "linkedin": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "instagram_story": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "instagram_reel": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "instagram": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "image": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "facebook_reel": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "facebook_live": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "facebook_group": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "facebook": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" }, "blog": { "properties": { "listMemberIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "count": { "type": "number", "format": "double" } }, "required": [ "listMemberIds", "count" ], "type": "object" } }, "required": [ "youtube_shorts", "youtube_video", "video", "twitter", "twitch_stream", "tiktok", "snapchat_story", "pinterest", "linkedin", "instagram_story", "instagram_reel", "instagram", "image", "facebook_reel", "facebook_live", "facebook_group", "facebook", "blog" ], "type": "object" } }, "required": [ "summary" ], "type": "object" }, "ListMemberDeliverableBulkAssignSummaryPostRequest": { "properties": { "listId": { "type": "number", "format": "double" }, "queryFilter": { "additionalProperties": true }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "required": [ "listId" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverableGetResponse": { "properties": { "deliverables": { "items": { "$ref": "#/definitions/ListMemberDeliverable" }, "type": "array" } }, "required": [ "deliverables" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverablePutRequest": { "properties": { "count": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "listMemberDeliverableId": { "type": "number", "format": "double" } }, "required": [ "count", "listId", "listMemberDeliverableId" ], "type": "object", "additionalProperties": false }, "ListMemberDeliverablesSummaryGetResponse": { "properties": { "summary": { "items": { "properties": { "count": { "type": "number", "format": "double" }, "contentTypeName": { "type": "object" }, "contentType": { "type": "object" } }, "required": [ "count", "contentTypeName", "contentType" ], "type": "object" }, "type": "array" } }, "required": [ "summary" ], "type": "object", "additionalProperties": false }, "SendMessageAttachment": { "properties": { "originalName": { "type": "string" }, "mimeType": { "type": "string" }, "disposition": { "type": "string" }, "size": { "type": "number", "format": "double" }, "index": { "type": "number", "format": "double" }, "buffer": { "type": "string" }, "encoding": { "type": "string" } }, "type": "object", "additionalProperties": false }, "BulkActionGroupScheduleMessagePostBody": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "subject": { "type": "string" }, "templates": { "items": { "additionalProperties": true }, "type": "array" }, "attachments": { "items": { "$ref": "#/definitions/SendMessageAttachment" }, "type": "array" }, "html": { "type": "string" }, "sendOnDate": { "type": "string", "format": "date-time" }, "globalUserIds": { "additionalProperties": true }, "addTalentManager": { "type": "boolean" }, "queryFilter": { "properties": { "customStatusId": { "items": { "type": "number", "format": "double" }, "type": "array" }, "orderProperty": { "type": "string" }, "expectedNumberOfInfluencers": { "type": "number", "format": "double" }, "excludedGlobalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "userFilter": { "additionalProperties": true } }, "required": [ "expectedNumberOfInfluencers", "excludedGlobalUserIds", "userFilter" ], "type": "object" } }, "required": [ "actionGroupId", "subject", "html", "sendOnDate", "addTalentManager" ], "type": "object", "additionalProperties": false }, "ScheduledMessageStatus": { "enum": [ "PENDING", "ERROR", "FAILED", "SENT" ], "type": "string" }, "DBScheduledMessage": { "properties": { "accountId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "messageId": { "type": "number", "format": "double" }, "sendAt": { "type": "string", "format": "date-time" }, "status": { "$ref": "#/definitions/ScheduledMessageStatus" }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "conversationId": { "type": "number", "format": "double" }, "message": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "accountId", "id", "communityId", "createdAt", "messageId", "sendAt", "status", "updatedAt" ], "type": "object", "additionalProperties": false }, "SendMessageInfluencer": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "profilePic": { "type": "string" } }, "type": "object", "additionalProperties": false }, "SendMessageRecipient": { "properties": { "displayName": { "type": "string" }, "email": { "type": "string" }, "role": { "type": "string" }, "influencer": { "$ref": "#/definitions/SendMessageInfluencer" } }, "type": "object", "additionalProperties": false }, "ActionGroupScheduledMessagePostBody": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "attachments": { "items": { "$ref": "#/definitions/SendMessageAttachment" }, "type": "array" }, "globalUserId": { "type": "number", "format": "double" }, "html": { "type": "string" }, "recipients": { "items": { "$ref": "#/definitions/SendMessageRecipient" }, "type": "array" }, "subject": { "type": "string" }, "templates": { "items": { "additionalProperties": true }, "type": "array" }, "sendOnDate": { "type": "string", "format": "date-time" } }, "required": [ "actionGroupId", "globalUserId", "html", "subject", "sendOnDate" ], "type": "object", "additionalProperties": false }, "MessageAttachment": { "properties": { "originalName": { "type": "string" }, "mimeType": { "type": "string" }, "disposition": { "type": "string" }, "size": { "type": "number", "format": "double" }, "index": { "type": "number", "format": "double" }, "encoding": { "type": "string" }, "buffer": { "type": "string" } }, "required": [ "originalName", "mimeType", "disposition", "size", "index", "encoding", "buffer" ], "type": "object", "additionalProperties": false }, "CannedResponse": { "properties": { "id": { "type": "number", "format": "double", "x-nullable": true }, "category": { "type": "string", "enum": [ "CANNED" ], "x-nullable": false }, "title": { "type": "string" }, "subject": { "type": "string" }, "html": { "type": "string" }, "createdBy": { "properties": { "image": { "type": "string" }, "last_name": { "type": "string" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "number", "format": "double", "x-nullable": true } }, "type": "object" }, "lastModifiedBy": { "properties": { "image": { "type": "string" }, "last_name": { "type": "string" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "id": { "type": "number", "format": "double", "x-nullable": true } }, "type": "object" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "isArchived": { "type": "boolean" } }, "required": [ "id", "category", "title", "subject", "html", "createdAt", "isArchived" ], "type": "object", "additionalProperties": false }, "ScheduledReplyMessagePostBody": { "properties": { "recipients": { "items": { "properties": { "influencer": { "properties": { "email": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "profilePic": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double", "x-nullable": true }, "actionGroupId": { "type": "number", "format": "double" } }, "type": "object" }, "role": { "type": "string" }, "displayName": { "type": "string", "x-nullable": true }, "emailId": { "type": "number", "format": "double" }, "email": { "type": "string" } }, "type": "object" }, "type": "array" }, "subject": { "type": "string" }, "html": { "type": "string" }, "attachments": { "items": { "$ref": "#/definitions/MessageAttachment" }, "type": "array" }, "templates": { "items": { "$ref": "#/definitions/CannedResponse" }, "type": "array" }, "actionGroupId": { "type": "number", "format": "double" }, "messageId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "sendOnDate": { "type": "string", "format": "date-time" } }, "required": [ "subject", "html" ], "type": "object", "additionalProperties": false }, "ScheduledReplyMessageResponse": { "properties": { "message": { "type": "object", "properties": { "recipients": { "items": { "properties": { "influencer": { "properties": { "email": { "type": "string" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "profilePic": { "type": "string" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double", "x-nullable": true }, "actionGroupId": { "type": "number", "format": "double" } }, "type": "object" }, "role": { "type": "string" }, "displayName": { "type": "string", "x-nullable": true }, "emailId": { "type": "number", "format": "double" }, "email": { "type": "string" } }, "type": "object" }, "type": "array" }, "subject": { "type": "string" }, "html": { "type": "string" }, "attachments": { "items": { "$ref": "#/definitions/MessageAttachment" }, "type": "array" }, "templates": { "items": { "$ref": "#/definitions/CannedResponse" }, "type": "array" }, "actionGroupId": { "type": "number", "format": "double" }, "messageId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "sendOnDate": { "type": "string", "format": "date-time" } } }, "scheduledMessageId": { "type": "number", "format": "double" } }, "required": [ "message", "scheduledMessageId" ], "type": "object", "additionalProperties": false }, "DBMessageRecipientView": { "properties": { "id": { "type": "number", "format": "double" }, "email": { "type": "string" }, "emailId": { "type": "number", "format": "double" }, "messageId": { "type": "number", "format": "double" }, "role": { "type": "string", "enum": [ "from", "to", "cc" ], "x-nullable": false }, "displayName": { "type": "string" } }, "required": [ "id", "email", "emailId", "messageId", "role" ], "type": "object", "additionalProperties": false }, "DBMessage": { "properties": { "recipients": { "items": { "$ref": "#/definitions/DBMessageRecipientView" }, "type": "array" }, "hasBeenOpened": { "type": "boolean" }, "hasBeenBounced": { "type": "boolean" }, "hasBeenDelivered": { "type": "boolean" }, "modifiedByAccountId": { "type": "number", "format": "double" }, "createdByAccountId": { "type": "number", "format": "double" }, "sentByAccountId": { "type": "number", "format": "double" }, "modifiedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "sentAt": { "type": "string", "format": "date-time" }, "conversationId": { "type": "number", "format": "double" }, "parsedReply": { "type": "string" }, "html": { "type": "string" }, "isInbound": { "type": "boolean" }, "inReplyToHeader": { "type": "string" }, "status": { "type": "string", "enum": [ "ARCHIVED", "DRAFT", "LIVE", "SCHEDULED" ], "x-nullable": false }, "messageIdHeader": { "type": "string" }, "subject": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "conversationId", "parsedReply", "html", "isInbound", "inReplyToHeader", "subject", "id" ], "type": "object" }, "ActionGroupScheduledMessageSendNowBody": { "properties": { "messageId": { "type": "number", "format": "double" }, "scheduledMessageId": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" } }, "required": [ "messageId", "scheduledMessageId" ], "type": "object", "additionalProperties": false }, "ActionGroupScheduledMessagePutBody": { "properties": { "sendOnDate": { "type": "string", "format": "date-time" }, "scheduleId": { "type": "number", "format": "double" }, "messageId": { "type": "number", "format": "double" }, "conversationId": { "type": "number", "format": "double" } }, "required": [ "sendOnDate", "scheduleId", "messageId" ], "type": "object", "additionalProperties": false }, "GetListResponse": { "properties": { "completed": { "type": "boolean" }, "dueDate": { "type": "object" }, "engagements": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" }, "listId": { "type": "number", "format": "double" }, "optedIn": { "type": "boolean" }, "optedInDate": { "type": "string" }, "statusId": { "type": "number", "format": "double" }, "statusLocked": { "type": "boolean" } }, "required": [ "globalUserId", "id", "listId", "statusId" ], "type": "object", "additionalProperties": false }, "ListMemberMavelyProfile": { "properties": { "id": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "actionGroupId": { "type": "number", "format": "double" }, "mavelyProfileId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "listMemberId", "globalUserId", "actionGroupId", "mavelyProfileId" ], "type": "object", "additionalProperties": false }, "MavelyListMember": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "globalUserId": { "type": "number", "format": "double" }, "mavelyProfileId": { "type": "string" } }, "required": [ "actionGroupId" ], "type": "object" }, "MavelyProfilesRequest": { "properties": { "mavelyListMembers": { "items": { "$ref": "#/definitions/MavelyListMember" }, "type": "array" } }, "required": [ "mavelyListMembers" ], "type": "object" }, "ListMemberFilters": { "properties": { "queryFilter": { "additionalProperties": true }, "actionGroupId": { "type": "number", "format": "double" } }, "required": [ "queryFilter", "actionGroupId" ], "type": "object" }, "NotificationType": { "enum": [ "MESSAGE", "DRAFT", "CONTENT", "APPLICATION", "CONFIRMATION", "FAILED_PAYMENT" ], "type": "string" }, "NotificationQueryFields": { "properties": { "notificationTypes": { "items": { "$ref": "#/definitions/NotificationType" }, "type": "array" }, "actionGroupId": { "type": "number", "format": "double" }, "notificationGroupId": { "type": "string" } }, "type": "object" }, "NotificationUpdateFields": { "properties": { "windowIsClosed": { "type": "boolean" }, "isUnread": { "type": "boolean" } }, "type": "object" }, "UpdateNotificationBodyDefinition": { "properties": { "data": { "$ref": "#/definitions/NotificationUpdateFields" }, "params": { "$ref": "#/definitions/NotificationQueryFields" } }, "required": [ "data", "params" ], "type": "object" }, "EmailNotificationTimeframe": { "enum": [ "TWO_H", "FOUR_H", "DAILY" ], "type": "string" }, "NotificationPreferenceFlags": { "properties": { "emailTimeframe": { "$ref": "#/definitions/EmailNotificationTimeframe" }, "emailConceptNotifications": { "type": "boolean" }, "emailFailedPaymentNotifications": { "type": "boolean" }, "emailDraftNotifications": { "type": "boolean" }, "emailApplicationNotifications": { "type": "boolean" }, "emailConfirmationNotifications": { "type": "boolean" }, "emailContentNotifications": { "type": "boolean" }, "emailMessageNotifications": { "type": "boolean" }, "showConceptNotifications": { "type": "boolean" }, "showFailedPaymentNotifications": { "type": "boolean" }, "showDraftNotifications": { "type": "boolean" }, "showApplicationNotifications": { "type": "boolean" }, "showConfirmationNotifications": { "type": "boolean" }, "showContentNotifications": { "type": "boolean" }, "showMessageNotifications": { "type": "boolean" } }, "required": [ "emailTimeframe", "emailFailedPaymentNotifications", "emailDraftNotifications", "emailApplicationNotifications", "emailConfirmationNotifications", "emailContentNotifications", "emailMessageNotifications", "showFailedPaymentNotifications", "showDraftNotifications", "showApplicationNotifications", "showConfirmationNotifications", "showContentNotifications", "showMessageNotifications" ], "type": "object", "description": "tsoa derives request validation from this type, so a non-optional property is a **required** body\nfield and a client that omits it gets a 400 `ValidateError`.\n\nThat is why the two concept flags are optional and the other twelve are not: later-influence sends\na fixed payload built from its own defaults object, so making these required would reject every\npreference save from any client older than CMP-1542 — and sapi and later-influence deploy on\nindependent cadences. Leaving them out is well defined rather than lossy: the columns are nullable\nwith defaults, and `NotificationPreferencesService.upsert` spreads this object into the statement,\nso an absent key keeps the column's default on insert and its current value on update. An old\nclient cannot clobber a preference it does not know about.\n\nDo not make these required until every client sends them." }, "SetNotificationPreferenceBodyDefinition": { "properties": { "actionGroupId": { "type": "string" }, "data": { "$ref": "#/definitions/NotificationPreferenceFlags" } }, "required": [ "actionGroupId", "data" ], "type": "object" }, "PostMembershipPurchaseResponse": { "properties": { "pointsAwarded": { "type": "string" } }, "required": [ "pointsAwarded" ], "type": "object", "additionalProperties": false }, "PostMembershipPurchaseBody": { "properties": { "orderId": { "type": "string" }, "purchaseValue": { "type": "string" } }, "required": [ "orderId", "purchaseValue" ], "type": "object", "additionalProperties": false }, "_MembershipContactInfo": { "properties": { "age": { "type": "number", "format": "double" }, "apt": { "type": "string" }, "birthday": { "type": "object" }, "city": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "emailIsVerified": { "type": "boolean" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "genderDescription": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" }, "talentManagerEmail": { "type": "string" } }, "type": "object", "additionalProperties": false }, "UpdateInfluencerContactInfoBody": { "properties": { "age": { "type": "number", "format": "double" }, "apt": { "type": "string" }, "birthday": { "type": "object" }, "city": { "type": "string" }, "country": { "type": "string" }, "email": { "type": "string" }, "emailIsVerified": { "type": "boolean" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "genderDescription": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" }, "talentManagerEmail": { "type": "string" }, "socialPresences": { "items": { "$ref": "#/definitions/SocialPresenceInput" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "updateSignatureBody": { "properties": { "signedTermsAndConditions": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "GetMembershipSummaryResponse": { "properties": { "totalPoints": { "type": "number", "format": "double" }, "totalActivations": { "type": "number", "format": "double" } }, "required": [ "totalPoints", "totalActivations" ], "type": "object", "additionalProperties": false }, "Pick_UpdateMemberContactInfoData.gender-or-genderDescription_": { "properties": { "gender": { "$ref": "#/definitions/Gender" }, "genderDescription": { "type": "string" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "EthnicGroup": { "enum": [ "American Indian or Alaska Native", "Asian", "Black or African American", "Hispanic, Latinx, or Spanish origin", "Other", "Pacific Islander", "Prefer not to say", "White" ], "type": "string" }, "MembershipEthnicity": { "properties": { "ethnicGroup": { "$ref": "#/definitions/EthnicGroup" }, "ethnicGroupDescription": { "type": "string" } }, "required": [ "ethnicGroup", "ethnicGroupDescription" ], "type": "object", "additionalProperties": false }, "MembershipProfileInfo": { "properties": { "membershipContactInfo": { "$ref": "#/definitions/Pick_UpdateMemberContactInfoData.gender-or-genderDescription_" }, "memberSelectedEthnicities": { "items": { "$ref": "#/definitions/MembershipEthnicity" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "UpdateMembershipProfileInfo": { "properties": { "data": { "$ref": "#/definitions/MembershipProfileInfo" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "GetMembershipResponse": { "properties": { "blacklisted": { "type": "boolean" }, "contactInfo": { "$ref": "#/definitions/MembershipContactInfoDeprecated" }, "createdAt": { "type": "string" }, "id": { "type": "number", "format": "double" }, "imageUrl": { "type": "string" }, "lifetimeClicks": { "type": "number", "format": "double" }, "lifetimeConversions": { "type": "number", "format": "double" }, "lifetimeConversionsValue": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "membershipType": { "type": "string" }, "mostRecentActivationDate": { "type": "string" }, "pointsCurrentBalance": { "properties": { "amount": { "type": "number", "format": "double" } }, "type": "object" }, "status": { "type": "string" }, "totalImpressions": { "type": "number", "format": "double" }, "totalPoints": { "type": "number", "format": "double" }, "updatedAt": { "type": "string" }, "utmCampaign": { "type": "string" }, "utmContent": { "type": "string" }, "fullName": { "type": "string" } }, "type": "object", "additionalProperties": false }, "updateMembershipBody": { "properties": { "blacklisted": { "type": "boolean" }, "status": { "type": "string", "enum": [ "USER", "REJECTED" ], "x-nullable": false }, "membershipType": { "type": "string", "enum": [ "EMPLOYEE", "CUSTOMER", "NORMAL" ], "x-nullable": false } }, "type": "object", "additionalProperties": false }, "removeMembershipBody": { "properties": { "activityId": { "type": "number", "format": "double" }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "MetaSystemUserPermissions": { "properties": { "data": { "items": { "properties": { "status": { "type": "string" }, "permission": { "type": "string" } }, "required": [ "status", "permission" ], "type": "object" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "MetaSystemUsersAdAccountsResponse": { "properties": { "adAccounts": { "items": { "properties": { "adAccount": { "properties": { "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "updatedAt", "createdAt", "name", "id" ], "type": "object" }, "updatedAt": { "type": "string" }, "createdAt": { "type": "string" }, "internalStatus": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "adAccount", "updatedAt", "createdAt", "internalStatus", "id" ], "type": "object" }, "type": "array" }, "permissions": { "$ref": "#/definitions/MetaSystemUserPermissions" }, "name": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "adAccounts", "permissions", "name", "id" ], "type": "object" }, "BackfillMetaAdInsightsJobPayload": { "properties": { "externalAdIdList": { "items": { "type": "string" }, "type": "array" }, "backfillOnlyNullEntries": { "type": "boolean" }, "batchSize": { "type": "number", "format": "double" }, "adAccountIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "type": "object" }, "PushMetaAdInsightsJobPayload": { "properties": { "endDate": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "format": "date-time" } }, "required": [ "endDate", "startDate" ], "type": "object" }, "MetaBusinessAssetAuthorizationDto": { "properties": { "id": { "type": "number", "format": "double" }, "type": { "type": "string" }, "name": { "type": "string" }, "selected": { "type": "boolean" }, "externalId": { "type": "string" }, "externalBusinessPortfolioId": { "type": "string" }, "administratorId": { "type": "number", "format": "double" }, "integrationId": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "handle": { "type": "string" }, "status": { "type": "number", "format": "double" }, "pictureUrl": { "type": "string" }, "externalFacebookPageId": { "type": "string" } }, "required": [ "id", "type", "name", "selected", "externalId", "externalBusinessPortfolioId", "administratorId", "integrationId", "communityId" ], "type": "object", "additionalProperties": false }, "UpdateBusinessAssetRequestBody": { "properties": { "selected": { "type": "boolean" } }, "required": [ "selected" ], "type": "object" }, "MetaBusinessPortfolioAuthorizationDto": { "properties": { "id": { "type": "number", "format": "double" }, "name": { "type": "string" }, "selected": { "type": "boolean" }, "pictureUrl": { "type": "string" }, "externalId": { "type": "string" }, "communityId": { "type": "string" }, "integrationId": { "type": "number", "format": "double" }, "administratorId": { "type": "number", "format": "double" } }, "required": [ "id", "name", "selected", "pictureUrl", "externalId", "communityId", "integrationId", "administratorId" ], "type": "object", "additionalProperties": false }, "UpdateBusinessPortfolioRequestBody": { "properties": { "selected": { "type": "boolean" } }, "required": [ "selected" ], "type": "object" }, "MetaBusinessIntegrationDto": { "properties": { "id": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "administratorId": { "type": "number", "format": "double" }, "externalBusinessId": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "id", "communityId", "administratorId", "externalBusinessId", "enabled" ], "type": "object", "additionalProperties": false }, "MetaConnectBusinessIntegrationRequestBody": { "properties": { "code": { "type": "string" } }, "required": [ "code" ], "type": "object" }, "MetaEnableBusinessIntegrationRequestBody": { "properties": { "enabled": { "type": "boolean", "enum": [ true ], "x-nullable": false } }, "required": [ "enabled" ], "type": "object" }, "MetaCreatePostPartnershipRequestBody": { "properties": { "activationId": { "type": "number", "format": "double" } }, "required": [ "activationId" ], "type": "object" }, "OpenAISearchBody": { "properties": { "query": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" } }, "required": [ "query", "city", "state" ], "type": "object", "additionalProperties": false }, "Pick_CreatorOptInRequest.social_medias_": { "properties": { "social_medias": { "$ref": "#/definitions/CreatorOptInRequestSocialMedias" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "CreatorOptInRequestWithCreatorProfileId": { "properties": { "creator_profile_id": { "type": "string" }, "influencer": { "$ref": "#/definitions/Pick_CreatorOptInRequest.social_medias_" } }, "required": [ "creator_profile_id" ], "type": "object", "additionalProperties": false }, "CreatorOptOutRequest": { "properties": { "creator_profile_id": { "type": "string" } }, "required": [ "creator_profile_id" ], "type": "object", "additionalProperties": false }, "PaymentsLedgerMetadata": { "properties": { "totalCount": { "type": "number", "format": "double" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" } }, "required": [ "totalCount", "limit", "offset" ], "type": "object", "additionalProperties": false }, "TaxLineItemType": { "type": "string", "enum": [ "GST", "HST", "VAT", "PST", "QST", "RST" ], "x-nullable": false }, "TaxLineItem": { "properties": { "amount": { "type": "number", "format": "double" }, "type": { "$ref": "#/definitions/TaxLineItemType" } }, "required": [ "amount", "type" ], "type": "object" }, "PaymentAccountType": { "enum": [ "CASH", "GIFT_CARD" ], "type": "string" }, "PaymentsLedger": { "properties": { "transactionDateTime": { "type": "string", "format": "date-time" }, "communityId": { "type": "string" }, "paymentAccountType": { "$ref": "#/definitions/PaymentAccountType" }, "actionGroupTitle": { "type": "string" }, "transactionDescription": { "type": "string" }, "paymentAccountTransactionId": { "type": "number", "format": "double" }, "transactionCreatedByEmail": { "type": "string" }, "recipientFullName": { "type": "string", "x-nullable": true }, "recipientEmail": { "type": "string" }, "providerSearchableTransactionId": { "type": "string", "x-nullable": true }, "externalId": { "type": "string" }, "cashPaymentProviderStatusMessage": { "type": "string", "x-nullable": true }, "cashPaymentStatusForFailure": { "type": "string", "x-nullable": true }, "cashPaymentProviderStatusCodeForFailure": { "type": "string", "x-nullable": true }, "cashPaymentProviderStatusMessageForFailure": { "type": "string", "x-nullable": true }, "paymentAccountId": { "type": "number", "format": "double" }, "rewardWinTitle": { "type": "string" }, "rewardWinType": { "$ref": "#/definitions/DBRewardWinType" }, "uniqueTransactionId": { "type": "string", "x-nullable": true }, "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "rewardWinId": { "type": "number", "format": "double", "x-nullable": true }, "listMemberId": { "type": "number", "format": "double", "x-nullable": true }, "globalUserId": { "type": "number", "format": "double", "x-nullable": true }, "listId": { "type": "number", "format": "double", "x-nullable": true }, "cashPaymentStatus": { "type": "string", "x-nullable": true }, "cashPaymentProviderStatusCode": { "type": "string", "x-nullable": true }, "transactionStatus": { "type": "string", "x-nullable": true }, "paymentAccountTitle": { "type": "string", "x-nullable": true }, "provider": { "$ref": "#/definitions/PaymentAppProvider" }, "valueCurrencyCode": { "type": "string", "x-nullable": true }, "costCurrencyCode": { "type": "string", "x-nullable": true }, "value": { "type": "number", "format": "double", "x-nullable": true }, "cost": { "type": "number", "format": "double", "x-nullable": true }, "exchangeRate": { "type": "number", "format": "double", "x-nullable": true }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "mavelyProfileId": { "type": "string", "x-nullable": true }, "invoiceNumber": { "type": "string", "x-nullable": true }, "taxId": { "type": "string", "x-nullable": true }, "taxLineItems": { "items": { "$ref": "#/definitions/TaxLineItem" }, "type": "array", "x-nullable": true } }, "required": [ "transactionDateTime", "communityId", "paymentAccountType", "actionGroupTitle", "transactionDescription", "paymentAccountTransactionId", "transactionCreatedByEmail", "recipientFullName", "recipientEmail", "providerSearchableTransactionId", "externalId", "cashPaymentProviderStatusMessage", "cashPaymentStatusForFailure", "cashPaymentProviderStatusCodeForFailure", "cashPaymentProviderStatusMessageForFailure", "paymentAccountId", "rewardWinTitle", "rewardWinType", "uniqueTransactionId", "actionGroupId", "rewardWinId", "listMemberId", "globalUserId", "listId", "cashPaymentStatus", "cashPaymentProviderStatusCode", "transactionStatus", "paymentAccountTitle", "provider", "valueCurrencyCode", "costCurrencyCode", "value", "cost", "exchangeRate", "budgetReferenceId", "budgetReferenceIdType" ], "type": "object", "additionalProperties": false }, "PaymentsLedgerQueryResponse": { "properties": { "meta": { "$ref": "#/definitions/PaymentsLedgerMetadata" }, "data": { "items": { "$ref": "#/definitions/PaymentsLedger" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object", "additionalProperties": false }, "ExchangeRate": { "properties": { "base": { "type": "string" }, "rates": { "properties": {}, "additionalProperties": { "type": "number", "format": "double" }, "type": "object" } }, "required": [ "base", "rates" ], "type": "object", "additionalProperties": false }, "ResponseBody_ExchangeRate_": { "properties": { "data": { "$ref": "#/definitions/ExchangeRate" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "DBPaymentAccount": { "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "currencyCode": { "type": "object" }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "description": { "type": "string" }, "accountType": { "$ref": "#/definitions/PaymentAccountType" }, "communityId": { "type": "string" }, "balance": { "type": "number", "format": "double" }, "id": { "type": "number", "format": "double" } }, "required": [ "currencyCode", "cashPaymentAppId", "description", "accountType", "communityId", "balance", "id" ], "type": "object" }, "DBCashPaymentApp": { "properties": { "includeFeesInTransactions": { "type": "boolean" }, "externalDescription": { "type": "string", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "environment": { "type": "string", "x-nullable": true }, "provider": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "includeFeesInTransactions", "externalDescription", "internalIdentifierCode", "environment", "provider", "id" ], "type": "object" }, "DBGiftCardApp": { "properties": { "externalDescription": { "type": "string", "x-nullable": true }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "environment": { "type": "string", "x-nullable": true }, "provider": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "externalDescription", "internalIdentifierCode", "environment", "provider", "id" ], "type": "object" }, "DBPaymentAccountWithAssociations": { "type": "object", "properties": {} }, "PaymentAccountNetDeposits": { "properties": { "paymentAccountId": { "type": "number", "format": "double" }, "currencyCode": { "type": "string", "x-nullable": true }, "netDeposits": { "type": "number", "format": "double" }, "earliestTransactionDate": { "type": "string", "format": "date-time" } }, "required": [ "paymentAccountId", "currencyCode", "netDeposits", "earliestTransactionDate" ], "type": "object", "additionalProperties": false }, "CreatePaymentAccountData": { "properties": { "currencyCode": { "type": "object" }, "communityId": { "type": "string" }, "cashPaymentAppId": { "type": "number", "format": "double" } }, "required": [ "communityId" ], "type": "object" }, "AccountingTransactionType": { "type": "string", "enum": [ "BALANCE_INCREASE", "BALANCE_DECREASE", "BALANCE_TRANSFER" ], "x-nullable": false }, "AccountingTransactionCreateDetails": { "properties": { "budgetReferenceIdType": { "type": "object" }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "targetPaymentAccountId": { "type": "number", "format": "double" }, "transactionType": { "$ref": "#/definitions/AccountingTransactionType" }, "description": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "paymentAccountId": { "type": "number", "format": "double" } }, "required": [ "transactionType", "description", "amount", "paymentAccountId" ], "type": "object" }, "StripeInternationalCurrency": { "properties": { "country": { "type": "string" }, "currencyCode": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" } }, "required": [ "country", "currencyCode", "name", "symbol" ], "type": "object", "additionalProperties": false }, "StripeSupportedCurrencies": { "items": { "$ref": "#/definitions/StripeInternationalCurrency" }, "type": "array" }, "PaymentAccountSupportedCurrencies": { "properties": { "instanceId": { "type": "string" }, "internationalCurrencies": { "type": "string", "x-nullable": true } }, "required": [ "instanceId", "internationalCurrencies" ], "type": "object", "additionalProperties": false }, "Partial_PaymentAccountSupportedCurrencies_": { "properties": { "instanceId": { "type": "string" }, "internationalCurrencies": { "type": "string", "x-nullable": true } }, "type": "object", "description": "Make all properties in T optional" }, "PaymentAccountSupportedCurrenciesRequestBody": { "properties": { "instanceId": { "type": "string" }, "internationalCurrencies": { "type": "string" } }, "required": [ "instanceId", "internationalCurrencies" ], "type": "object", "additionalProperties": false }, "TaxUpdateRequestDTO": { "properties": { "taxId": { "type": "string", "x-nullable": true }, "invoiceNumber": { "type": "string", "x-nullable": true }, "taxLineItems": { "items": { "$ref": "#/definitions/TaxLineItem" }, "type": "array", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "UpdatePaymentAccountTransactionRequestDTO": { "properties": { "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "taxId": { "type": "string", "x-nullable": true }, "invoiceNumber": { "type": "string", "x-nullable": true }, "taxLineItems": { "items": { "$ref": "#/definitions/TaxLineItem" }, "type": "array", "x-nullable": true }, "communityId": { "type": "string" } }, "type": "object", "additionalProperties": false }, "CashPaymentPermission": { "properties": { "canAddTransactions": { "type": "boolean" }, "cashPaymentAppId": { "type": "number", "format": "double" } }, "required": [ "canAddTransactions", "cashPaymentAppId" ], "type": "object", "additionalProperties": false }, "GiftCardPaymentPermission": { "properties": { "canAddTransactions": { "type": "boolean" }, "giftCardAppId": { "type": "number", "format": "double" } }, "required": [ "canAddTransactions", "giftCardAppId" ], "type": "object", "additionalProperties": false }, "PaymentAppAdmin": { "properties": { "s4AccountId": { "type": "number", "format": "double" }, "cashPaymentPermissions": { "items": { "$ref": "#/definitions/CashPaymentPermission" }, "type": "array" }, "giftCardPermissions": { "items": { "$ref": "#/definitions/GiftCardPaymentPermission" }, "type": "array" } }, "required": [ "s4AccountId", "cashPaymentPermissions", "giftCardPermissions" ], "type": "object", "additionalProperties": false }, "PaymentProvider": { "properties": { "externalDescription": { "type": "string" }, "internalIdentifierCode": { "type": "string", "x-nullable": true }, "provider": { "type": "string" } }, "required": [ "externalDescription", "internalIdentifierCode", "provider" ], "type": "object", "additionalProperties": false }, "ConfigureMavrckProviderAppToInstanceBody": { "properties": { "appType": { "$ref": "#/definitions/PaymentAccountType" }, "provider": { "$ref": "#/definitions/PaymentAppProvider" }, "communityId": { "type": "string" }, "currencyCode": { "type": "object" } }, "required": [ "appType", "provider" ], "type": "object", "additionalProperties": false }, "AuthenticatedInfluencerSocialMediaProfile": { "properties": { "expiresAt": { "type": "string" }, "handle": { "type": "string" }, "profilePicture": { "type": "string" } }, "required": [ "expiresAt", "handle" ], "type": "object", "additionalProperties": false }, "PinterestAuthPostResponse": { "properties": { "pinterest": { "$ref": "#/definitions/AuthenticatedInfluencerSocialMediaProfile" }, "token": { "type": "string" } }, "required": [ "pinterest", "token" ], "type": "object", "additionalProperties": false }, "PinterestAuthPostRequestBody": { "properties": { "code": { "type": "string" }, "redirectUri": { "type": "string" } }, "required": [ "code", "redirectUri" ], "type": "object", "additionalProperties": false }, "CreatorProfileUpsertEventData": { "properties": { "discoveredSource": { "type": "string", "x-nullable": true }, "id": { "type": "string" }, "subject": { "type": "string", "enum": [ "CREATOR_PROFILE_CREATE", "CREATOR_PROFILE_UPDATE" ], "x-nullable": false } }, "required": [ "id", "subject" ], "type": "object" }, "CreatorSocialPresenceRemoveByCpIdEvent": { "properties": { "creatorProfileId": { "type": "string" }, "subject": { "type": "string", "enum": [ "CREATOR_SOCIAL_PRESENCE_REMOVE" ], "x-nullable": false } }, "required": [ "creatorProfileId", "subject" ], "type": "object" }, "CreatorProfileUpsertEvent": { "type": "object" }, "ExpiringAccessTokenEvent": { "properties": { "tokenId": { "type": "string" }, "tokenExpiresAt": { "type": "string", "x-nullable": true }, "refreshTokenExpiresAt": { "type": "string", "x-nullable": true }, "platform": { "type": "string" }, "eventType": { "type": "string" }, "appId": { "type": "string" } }, "required": [ "tokenId", "tokenExpiresAt", "refreshTokenExpiresAt", "platform", "eventType", "appId" ], "type": "object" }, "SocialPresenceCreateEvent": { "properties": { "id": { "type": "string" }, "platformId": { "type": "string", "x-nullable": true }, "platform": { "type": "string" }, "subject": { "type": "string", "enum": [ "SOCIAL_PRESENCE_CREATE" ], "x-nullable": false } }, "required": [ "id", "platform", "subject" ], "type": "object" }, "IAccessTokenSocialProfileEvent": { "properties": { "appId": { "type": "string" }, "eventType": { "type": "string" }, "platform": { "type": "string" }, "platformId": { "type": "string", "x-nullable": true }, "subject": { "type": "string" }, "tokenType": { "type": "string" }, "username": { "type": "string" } }, "required": [ "appId", "eventType", "platform", "subject", "tokenType", "username" ], "type": "object", "additionalProperties": false }, "NewSocialProfileEvent": { "type": "object", "properties": { "appId": { "type": "string" }, "eventType": { "type": "string" }, "platform": { "type": "string" }, "platformId": { "type": "string", "x-nullable": true }, "subject": { "type": "string" }, "tokenType": { "type": "string" }, "username": { "type": "string" } } }, "AccessTokenSocialProfileEvent": { "$ref": "#/definitions/NewSocialProfileEvent" }, "CreatorSocialPresenceRemoveBySpIdEvent": { "properties": { "subject": { "type": "string", "enum": [ "CREATOR_SOCIAL_PRESENCE_REMOVE" ], "x-nullable": false }, "socialPresenceId": { "type": "string" } }, "required": [ "subject", "socialPresenceId" ], "type": "object" }, "SocialPresenceUpdateEvent": { "properties": { "subject": { "type": "string", "enum": [ "SOCIAL_PRESENCE_UPDATE" ], "x-nullable": false }, "platformId": { "type": "string", "x-nullable": true }, "platform": { "type": "string" }, "id": { "type": "string" } }, "required": [ "subject", "platform", "id" ], "type": "object" }, "SocialProfileUpdateEvent": { "type": "object" }, "CommunityActionObjectiveDefinition": { "properties": { "points": { "type": "number", "format": "double" }, "objectiveId": { "type": "number", "format": "double" } }, "required": [ "points", "objectiveId" ], "type": "object" }, "GetCommunityActionObjectiveResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/CommunityActionObjectiveDefinition" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "CommunityEngagementPointMapping": { "properties": { "ratio": { "type": "number", "format": "double" }, "maxPointsCap": { "type": "number", "format": "double" }, "stepAmount": { "type": "number", "format": "double" } }, "type": "object" }, "GetCommunityEngagementPointMappingResponse": { "properties": { "data": { "$ref": "#/definitions/CommunityEngagementPointMapping" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "PollingQueueType": { "enum": [ "instagram", "instagram-story", "non-instagram" ], "type": "string" }, "PurgeQueueResponse": { "properties": { "queue": { "$ref": "#/definitions/PollingQueueType" }, "queueUrl": { "type": "string" }, "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "queue", "queueUrl", "success", "message" ], "type": "object", "additionalProperties": false }, "QueueStats": { "properties": { "queueUrl": { "type": "string" }, "approximateNumberOfMessages": { "type": "number", "format": "double" }, "approximateNumberOfMessagesNotVisible": { "type": "number", "format": "double" }, "approximateNumberOfMessagesDelayed": { "type": "number", "format": "double" } }, "required": [ "queueUrl", "approximateNumberOfMessages", "approximateNumberOfMessagesNotVisible", "approximateNumberOfMessagesDelayed" ], "type": "object", "additionalProperties": false }, "AllQueueStatsResponse": { "properties": { "queues": { "properties": { "nonInstagram": { "type": "object" }, "instagramStory": { "type": "object" }, "instagram": { "type": "object" } }, "required": [ "nonInstagram", "instagramStory", "instagram" ], "type": "object" } }, "required": [ "queues" ], "type": "object", "additionalProperties": false }, "PowerReviewsAppPostBody": { "properties": { "apiKey": { "type": "string" }, "environment": { "type": "string" }, "locale": { "type": "string" }, "merchantId": { "type": "string" }, "name": { "type": "string" } }, "required": [ "apiKey", "locale", "merchantId", "name" ], "type": "object", "additionalProperties": false }, "PowerReviewsAppsGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/PowerReviewsApp" }, "type": "array" } }, "type": "object" }, "PowerReviewsProductRequestBody": { "properties": { "powerReviewsAppId": { "type": "string" }, "externalPageId": { "type": "string" }, "image": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "productId": { "type": "number", "format": "double" } }, "required": [ "externalPageId", "image", "description", "title" ], "type": "object" }, "ResponseBody_Product-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/Product" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "Readonly_any_": { "properties": {}, "type": "object", "description": "Make all properties in T readonly" }, "ReportsTableSortModel": { "properties": { "id": { "type": "string" }, "desc": { "type": "boolean" } }, "required": [ "id", "desc" ], "type": "object", "additionalProperties": false }, "ReportingGranularity": { "type": "string", "enum": [ "year", "quarter", "month", "week", "day" ], "x-nullable": false }, "ReportsFilters": { "properties": { "campaignsActiveView": { "type": "string" }, "campaignsSortModel": { "$ref": "#/definitions/ReportsTableSortModel" }, "campaignsVisibleColumns": { "items": { "type": "string" }, "type": "array" }, "campaignsGallerySortModel": { "$ref": "#/definitions/ReportsTableSortModel" }, "campaignsGalleryVisibleColumns": { "items": { "type": "string" }, "type": "array" }, "networksSortModel": { "$ref": "#/definitions/ReportsTableSortModel" }, "networksVisibleColumns": { "items": { "type": "string" }, "type": "array" }, "topContentActiveView": { "type": "string" }, "topContentSortBy": { "type": "string" }, "topContentSortModel": { "$ref": "#/definitions/ReportsTableSortModel" }, "topContentVisibleColumns": { "items": { "type": "string" }, "type": "array" }, "topPerformersActiveView": { "type": "string" }, "topPerformersSortModel": { "$ref": "#/definitions/ReportsTableSortModel" }, "topPerformersSortBy": { "type": "string" }, "topPerformersVisibleColumns": { "items": { "type": "string" }, "type": "array" }, "trendsOverTimeGranularity": { "$ref": "#/definitions/ReportingGranularity" }, "trendsOverTimeVisibleMetrics": { "items": { "type": "string" }, "type": "array" }, "network": { "type": "string" }, "mediaType": { "type": "string" }, "contentDateType": { "type": "string" }, "mavelyIntegrationFeatureFlag": { "type": "boolean" }, "instagramPaidMediaFeatureFlag": { "type": "boolean" }, "tiktokPaidMediaFeatureFlag": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "MarketerFiltersItem": { "properties": { "filters": { "properties": { "reportsFilters": { "$ref": "#/definitions/ReportsFilters" }, "actionGroupIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "sortDirection": { "type": "string" }, "sortColumn": { "type": "string" }, "fromDate": { "type": "string" }, "toDate": { "type": "string" } }, "type": "object" } }, "required": [ "filters" ], "type": "object", "additionalProperties": false }, "MarketerFilterPreferenceBody": { "properties": { "filters": { "properties": { "reportsFilters": { "$ref": "#/definitions/ReportsFilters" }, "actionGroupIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "sortDirection": { "type": "string" }, "sortColumn": { "type": "string" }, "fromDate": { "type": "string" }, "toDate": { "type": "string" } }, "type": "object" }, "communityId": { "type": "string" }, "s4AccountId": { "type": "number", "format": "double" } }, "required": [ "filters", "communityId", "s4AccountId" ], "type": "object", "additionalProperties": false }, "PostRequestBody": { "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "resetKey": { "type": "string" } }, "required": [ "email", "password", "resetKey" ], "type": "object", "additionalProperties": false }, "ExportedReviewFormGetResponse": { "properties": { "createdAt": { "type": "string", "format": "date-time" }, "responses": { "items": { "properties": { "responseValue": { "type": "string" }, "questionKey": { "type": "string" }, "questionValue": { "type": "string" } }, "type": "object" }, "type": "array" }, "rating": { "type": "number", "format": "double" }, "campaignId": { "type": "number", "format": "double" }, "campaignTitle": { "type": "string" }, "product": { "type": "string" }, "reviewerMembershipId": { "type": "number", "format": "double" }, "reviewerFullName": { "type": "string" }, "reviewerEmail": { "type": "string" } }, "required": [ "createdAt", "responses", "campaignId" ], "type": "object", "additionalProperties": false }, "EventType": { "enum": [ "MANUAL", "ACCEPTANCE", "COMPLETION", "PENDING_CONTENT", "PENDING_PAYMENT" ], "type": "string" }, "CreationOptional_number_": { "type": "object", "properties": {}, "description": "This is a Branded Type.\nYou can use it to tag attributes that can be ommited during Model Creation.\n\nFor use with {@link InferCreationAttributes}." }, "Pick_CashPaymentApp.id-or-provider_": { "properties": { "id": { "$ref": "#/definitions/CreationOptional_number_" }, "provider": { "type": "string" } }, "required": [ "id", "provider" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "GetRewardWinCashPaymentApp": { "$ref": "#/definitions/Pick_CashPaymentApp.id-or-provider_" }, "Pick_ListMemberRewardWin.id-or-listMemberId-or-eligibleOnEventType_": { "properties": { "id": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "eligibleOnEventType": { "$ref": "#/definitions/EventType" } }, "required": [ "id", "listMemberId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "GetRewardWinListMemberRewardWin": { "$ref": "#/definitions/Pick_ListMemberRewardWin.id-or-listMemberId-or-eligibleOnEventType_" }, "Pick_GlobalUser.-or-id-or-fullName-or-firstName-or-lastName-or-country-or-state-or-city-or-zip-or-street-or-apt-or-phone-or-age-or-gender-or-email-or-birthday_": { "properties": { "id": { "type": "object" }, "email": { "type": "string" }, "gender": { "$ref": "#/definitions/Gender" }, "apt": { "type": "string" }, "birthday": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "lastName": { "type": "string" }, "phone": { "type": "string" }, "state": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" }, "age": { "type": "object" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "GetRewardWinGlobalUser": { "type": "object", "properties": {} }, "Pick_ActionGroup.-or-id-or-communityId-or-type-or-name-or-title-or-description-or-status-or-startDate-or-endDate-or-createdAt-or-notInCommunity-or-isAutoCreated-or-isPrimaryReferralActivity-or-multipleActivations-or-listId-or-locale-or-ftcHashtag-or-activityBudget-or-numberOfInfluencers-or-cpeGoal-or-cpmGoal-or-impressionsGoal-or-engagementsGoal-or-engagementRateGoal-or-contentDueDate-or-draftDueDate-or-hasPointsEnabled-or-autoAcceptApplicant-or-globalUserListDefinitionId-or-hideOnIcm-or-budgetReferenceId-or-budgetReferenceIdType_": { "properties": { "name": { "type": "string" }, "id": { "type": "number", "format": "double" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "communityId": { "type": "string" }, "title": { "type": "string" }, "ftcHashtag": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" }, "budgetReferenceId": { "type": "string", "x-nullable": true }, "budgetReferenceIdType": { "type": "object" }, "listId": { "type": "number", "format": "double" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "notInCommunity": { "type": "boolean" }, "isAutoCreated": { "type": "boolean" }, "isPrimaryReferralActivity": { "type": "boolean" }, "multipleActivations": { "type": "boolean" }, "locale": { "type": "string" }, "activityBudget": { "type": "number", "format": "double" }, "numberOfInfluencers": { "type": "number", "format": "double" }, "cpeGoal": { "type": "number", "format": "double" }, "cpmGoal": { "type": "number", "format": "double" }, "impressionsGoal": { "type": "number", "format": "double" }, "engagementsGoal": { "type": "number", "format": "double" }, "engagementRateGoal": { "type": "number", "format": "double" }, "contentDueDate": { "type": "string" }, "draftDueDate": { "type": "string" }, "hasPointsEnabled": { "type": "boolean" }, "autoAcceptApplicant": { "type": "boolean" }, "globalUserListDefinitionId": { "type": "number", "format": "double" }, "hideOnIcm": { "type": "boolean" } }, "required": [ "id", "communityId" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "GetRewardWinActionGroup": { "$ref": "#/definitions/Pick_ActionGroup.-or-id-or-communityId-or-type-or-name-or-title-or-description-or-status-or-startDate-or-endDate-or-createdAt-or-notInCommunity-or-isAutoCreated-or-isPrimaryReferralActivity-or-multipleActivations-or-listId-or-locale-or-ftcHashtag-or-activityBudget-or-numberOfInfluencers-or-cpeGoal-or-cpmGoal-or-impressionsGoal-or-engagementsGoal-or-engagementRateGoal-or-contentDueDate-or-draftDueDate-or-hasPointsEnabled-or-autoAcceptApplicant-or-globalUserListDefinitionId-or-hideOnIcm-or-budgetReferenceId-or-budgetReferenceIdType_" }, "Partial_GetRewardWin_": { "properties": { "communityId": { "type": "string" }, "completedDate": { "type": "string" }, "cashPaymentApp": { "$ref": "#/definitions/GetRewardWinCashPaymentApp" }, "listMemberRewardWin": { "$ref": "#/definitions/GetRewardWinListMemberRewardWin" }, "user": { "$ref": "#/definitions/GetRewardWinGlobalUser" }, "actionGroup": { "$ref": "#/definitions/GetRewardWinActionGroup" }, "mostRecentTransaction": { "$ref": "#/definitions/PaymentsLedger" }, "incentiveId": { "type": "number", "format": "double", "x-nullable": true }, "taxLineItems": { "items": { "$ref": "#/definitions/TaxLineItem" }, "type": "array", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "rewardTitle": { "type": "string" }, "rewardImage": { "type": "string", "x-nullable": true }, "isFulfilled": { "type": "boolean" }, "fulfilledAt": { "type": "string", "format": "date-time", "x-nullable": true }, "fulfilledByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "orderNumber": { "type": "string", "x-nullable": true }, "trackingNumber": { "type": "string", "x-nullable": true }, "comment": { "type": "string", "x-nullable": true }, "membershipId": { "type": "number", "format": "double" }, "isArchived": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "verifiedAddress": { "type": "boolean" }, "fulfillmentStatus": { "$ref": "#/definitions/FulfillmentStatus" }, "type": { "$ref": "#/definitions/DBRewardWinType" }, "value": { "type": "number", "format": "double", "x-nullable": true }, "cost": { "type": "number", "format": "double", "x-nullable": true }, "costCurrencyCode": { "type": "string" }, "valueCurrencyCode": { "type": "string" }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode" }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true }, "attainedBonusTierIndex": { "type": "number", "format": "double", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "createdByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "lastModifiedByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "readiedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "giftCardOptionId": { "type": "number", "format": "double", "x-nullable": true }, "giftCardEmailTemplateId": { "type": "string", "x-nullable": true }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "uniqueIdentifierForProviderApi": { "type": "string", "x-nullable": true }, "discountCodeId": { "type": "string", "x-nullable": true }, "discountCodeRedeemId": { "type": "string", "x-nullable": true }, "shippingCodeId": { "type": "string", "x-nullable": true }, "shippingCodeRedeemId": { "type": "string", "x-nullable": true }, "couponActivation": { "type": "string", "x-nullable": true }, "taxId": { "type": "string", "x-nullable": true }, "invoiceNumber": { "type": "string", "x-nullable": true } }, "type": "object", "description": "Make all properties in T optional" }, "ListMemberRewardWinResponse": { "properties": { "id": { "type": "number", "format": "double" }, "rewardWinId": { "type": "number", "format": "double" }, "listMemberId": { "type": "number", "format": "double" }, "eligibleOnEventType": { "$ref": "#/definitions/EventType" }, "proposalBased": { "type": "boolean", "x-nullable": true }, "RewardWin": { "$ref": "#/definitions/Partial_GetRewardWin_" } }, "required": [ "id", "rewardWinId", "listMemberId", "eligibleOnEventType", "RewardWin" ], "type": "object", "additionalProperties": false }, "GetListMemberRewardWinResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ListMemberRewardWinResponse" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ListMemberRewardWinRequestBody": { "properties": { "id": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "rewardWinId": { "type": "number", "format": "double" }, "eligibleOnEventType": { "type": "string" }, "RewardWin": { "additionalProperties": true }, "shopify": { "type": "object" } }, "required": [ "eligibleOnEventType", "RewardWin" ], "type": "object", "additionalProperties": false }, "BulkActionFailedInstance": { "properties": { "rewardWinId": { "type": "number", "format": "double" }, "errorType": { "type": "string" }, "errorMessage": { "type": "string" } }, "required": [ "rewardWinId", "errorType", "errorMessage" ], "type": "object", "additionalProperties": false }, "BulkActionSuccesfulInstance": { "properties": { "rewardWinId": { "type": "number", "format": "double" } }, "required": [ "rewardWinId" ], "type": "object", "additionalProperties": false }, "BulkMetadata": { "properties": { "failedInstances": { "items": { "$ref": "#/definitions/BulkActionFailedInstance" }, "type": "array" }, "succesfulInstances": { "items": { "$ref": "#/definitions/BulkActionSuccesfulInstance" }, "type": "array" } }, "required": [ "failedInstances", "succesfulInstances" ], "type": "object", "additionalProperties": false }, "RewardWinBulkFulfillmentParams": { "properties": { "rewardWinId": { "type": "integer", "format": "int32", "minimum": 1 }, "attainedBonusTierIndex": { "type": "integer", "format": "int32", "description": "Zero-based index of the manager-approved tier in the RewardWin's persisted bonus tier ladder.\nRequired when fulfilling a tier bonus RewardWin and rejected for non-tier RewardWins.", "minimum": 0 } }, "required": [ "rewardWinId" ], "type": "object", "additionalProperties": false }, "Pick_RewardWinUpdateBody.id-or-orderNumber-or-trackingNumber-or-comment-or-isArchived_": { "properties": { "id": { "type": "number", "format": "double" }, "isArchived": { "type": "boolean" }, "orderNumber": { "type": "string", "x-nullable": true }, "trackingNumber": { "type": "string", "x-nullable": true }, "comment": { "type": "string", "x-nullable": true } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "RewardWinBulkUpdateBody": { "$ref": "#/definitions/Pick_RewardWinUpdateBody.id-or-orderNumber-or-trackingNumber-or-comment-or-isArchived_", "description": "Body for PUT /v1/reward-wins/update-objects/bulk.\n\nExplicit allowlist of the fields the bulk-edit endpoint may change: the incentive `id`\n(match key), Order Number, Tracking Number, Comment, and the archive flag. Everything else\non `RewardWinUpdateBody` (fulfillmentStatus, cost, value, tax fields, ...) is intentionally\nexcluded — tsoa strips unknown fields at the edge before they reach the controller. New\nbulk-editable fields must be added here deliberately." }, "FulfillmentStatusFilter": { "type": "string", "enum": [ "PENDING", "REJECTED", "DRAFT", "READY", "FULFILLED" ], "x-nullable": false }, "RewardWinQueryParams": { "properties": { "isArchived": { "type": "boolean" }, "fulfillmentStatus": { "items": { "$ref": "#/definitions/FulfillmentStatusFilter" }, "type": "array" }, "type": { "type": "string" }, "actionGroupId": { "items": { "type": "number", "format": "double" }, "type": "array" }, "q": { "type": "string" }, "daysReady": { "type": "number", "format": "double" }, "excludedRewardWinIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "includedRewardWinIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "userFilter": { "additionalProperties": true }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" } }, "type": "object", "additionalProperties": false }, "PaginationWithSortingQueryParams": { "properties": { "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "orderField": { "type": "string" }, "orderDirection": { "type": "string", "enum": [ "ASC", "DESC" ], "x-nullable": false } }, "type": "object", "additionalProperties": false }, "RewardWinQueryFilter": { "type": "object", "properties": { "isArchived": { "type": "boolean" }, "fulfillmentStatus": { "items": { "$ref": "#/definitions/FulfillmentStatusFilter" }, "type": "array" }, "type": { "type": "string" }, "actionGroupId": { "items": { "type": "number", "format": "double" }, "type": "array" }, "q": { "type": "string" }, "daysReady": { "type": "number", "format": "double" }, "excludedRewardWinIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "includedRewardWinIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "userFilter": { "additionalProperties": true }, "globalUserIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "orderField": { "type": "string" }, "orderDirection": { "type": "string", "enum": [ "ASC", "DESC" ], "x-nullable": false } } }, "BulkUpdateWithFilterRequestBody": { "properties": { "rewardWinQueryFilter": { "$ref": "#/definitions/RewardWinQueryFilter" }, "rewardWinUpdateBody": { "$ref": "#/definitions/RewardWinBulkUpdateBody" } }, "required": [ "rewardWinQueryFilter", "rewardWinUpdateBody" ], "type": "object", "additionalProperties": false }, "BulkActionWithFilterRequestBody": { "properties": { "rewardWinQueryFilter": { "$ref": "#/definitions/RewardWinQueryFilter" } }, "required": [ "rewardWinQueryFilter" ], "type": "object", "additionalProperties": false }, "GetRewardWinMetadata": { "properties": { "limit": { "type": "number", "format": "double" }, "totalCount": { "type": "number", "format": "double" } }, "required": [ "limit", "totalCount" ], "type": "object", "additionalProperties": false }, "GetRewardWin": { "properties": { "taxLineItems": { "items": { "$ref": "#/definitions/TaxLineItem" }, "type": "array", "x-nullable": true }, "invoiceNumber": { "type": "string", "x-nullable": true }, "taxId": { "type": "string", "x-nullable": true }, "couponActivation": { "type": "string", "x-nullable": true }, "shippingCodeRedeemId": { "type": "string", "x-nullable": true }, "shippingCodeId": { "type": "string", "x-nullable": true }, "discountCodeRedeemId": { "type": "string", "x-nullable": true }, "discountCodeId": { "type": "string", "x-nullable": true }, "uniqueIdentifierForProviderApi": { "type": "string", "x-nullable": true }, "cashPaymentAppId": { "type": "number", "format": "double", "x-nullable": true }, "giftCardEmailTemplateId": { "type": "string", "x-nullable": true }, "giftCardOptionId": { "type": "number", "format": "double", "x-nullable": true }, "readiedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "lastModifiedByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "createdByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "description": { "type": "string", "x-nullable": true }, "attainedBonusTierIndex": { "type": "number", "format": "double", "x-nullable": true }, "bonusTiers": { "items": { "$ref": "#/definitions/BonusTier" }, "type": "array", "x-nullable": true }, "bonusTierCurrencyCode": { "$ref": "#/definitions/NullableBonusTierCurrencyCode" }, "valueCurrencyCode": { "type": "string" }, "costCurrencyCode": { "type": "string" }, "cost": { "type": "number", "format": "double", "x-nullable": true }, "value": { "type": "number", "format": "double", "x-nullable": true }, "type": { "$ref": "#/definitions/DBRewardWinType" }, "fulfillmentStatus": { "$ref": "#/definitions/FulfillmentStatus" }, "verifiedAddress": { "type": "boolean" }, "updatedAt": { "type": "string", "format": "date-time", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time", "x-nullable": true }, "isArchived": { "type": "boolean" }, "membershipId": { "type": "number", "format": "double" }, "comment": { "type": "string", "x-nullable": true }, "trackingNumber": { "type": "string", "x-nullable": true }, "orderNumber": { "type": "string", "x-nullable": true }, "fulfilledByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "fulfilledAt": { "type": "string", "format": "date-time", "x-nullable": true }, "isFulfilled": { "type": "boolean" }, "rewardImage": { "type": "string", "x-nullable": true }, "rewardTitle": { "type": "string" }, "id": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "completedDate": { "type": "string" }, "cashPaymentApp": { "$ref": "#/definitions/GetRewardWinCashPaymentApp" }, "listMemberRewardWin": { "$ref": "#/definitions/GetRewardWinListMemberRewardWin" }, "user": { "$ref": "#/definitions/GetRewardWinGlobalUser" }, "actionGroup": { "$ref": "#/definitions/GetRewardWinActionGroup" }, "mostRecentTransaction": { "$ref": "#/definitions/PaymentsLedger" }, "incentiveId": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "taxLineItems", "invoiceNumber", "taxId", "couponActivation", "shippingCodeRedeemId", "shippingCodeId", "discountCodeRedeemId", "discountCodeId", "uniqueIdentifierForProviderApi", "cashPaymentAppId", "giftCardEmailTemplateId", "giftCardOptionId", "readiedAt", "lastModifiedByAccountId", "createdByAccountId", "description", "attainedBonusTierIndex", "bonusTiers", "bonusTierCurrencyCode", "valueCurrencyCode", "costCurrencyCode", "cost", "value", "type", "fulfillmentStatus", "verifiedAddress", "updatedAt", "createdAt", "isArchived", "membershipId", "comment", "trackingNumber", "orderNumber", "fulfilledByAccountId", "fulfilledAt", "isFulfilled", "rewardImage", "rewardTitle", "id", "communityId", "completedDate", "cashPaymentApp", "listMemberRewardWin", "user", "actionGroup" ], "type": "object", "additionalProperties": false }, "GetRewardWinsResponse": { "properties": { "meta": { "$ref": "#/definitions/GetRewardWinMetadata" }, "data": { "items": { "$ref": "#/definitions/GetRewardWin" }, "type": "array" } }, "required": [ "meta", "data" ], "type": "object", "additionalProperties": false }, "RewardWinFulfillmentParams": { "properties": { "budgetReferenceId": { "type": "string" }, "budgetReferenceIdType": { "$ref": "#/definitions/BudgetReferenceIdType" }, "attainedBonusTierIndex": { "type": "integer", "format": "int32", "description": "Zero-based index of the manager-approved tier in the RewardWin's persisted bonus tier ladder.\nRequired when fulfilling a tier bonus RewardWin and rejected for non-tier RewardWins.", "minimum": 0 } }, "type": "object", "additionalProperties": false }, "RewardWinSummary": { "properties": { "cost": { "properties": { "sum": { "type": "number", "format": "double" } }, "required": [ "sum" ], "type": "object" } }, "required": [ "cost" ], "type": "object", "additionalProperties": false }, "RewardWinSummaryByCurrency": { "properties": { "currencyCode": { "type": "string" }, "pendingCost": { "type": "number", "format": "double" }, "readyCost": { "type": "number", "format": "double" }, "fulfilledCost": { "type": "number", "format": "double" } }, "required": [ "currencyCode", "pendingCost", "readyCost", "fulfilledCost" ], "type": "object", "additionalProperties": false }, "GetSummaryResponse": { "properties": { "summary": { "properties": { "fulfilled": { "$ref": "#/definitions/RewardWinSummary" }, "ready": { "$ref": "#/definitions/RewardWinSummary" }, "pending": { "$ref": "#/definitions/RewardWinSummary" } }, "required": [ "fulfilled", "ready", "pending" ], "type": "object" }, "summaryByCurrency": { "items": { "$ref": "#/definitions/RewardWinSummaryByCurrency" }, "type": "array" } }, "required": [ "summary", "summaryByCurrency" ], "type": "object", "additionalProperties": false }, "InferAttributes_s4InstanceBranding_": { "properties": { "brandingId": { "type": "object", "properties": {} }, "favicon": { "type": "string" }, "logoSmall": { "type": "string" }, "logoMedium": { "type": "string" }, "logoLarge": { "type": "string" }, "primaryColor": { "type": "object", "properties": {} }, "hoverColor": { "type": "object", "properties": {} }, "secondaryColor": { "type": "object", "properties": {} }, "title": { "type": "string" }, "customCss": { "type": "string" }, "hostname": { "type": "string" }, "email": { "type": "object", "properties": {} }, "webAddress": { "type": "object", "properties": {} } }, "type": "object", "description": "Utility type to extract Attributes of a given Model class.\n\nIt returns all instance properties defined in the Model, except:\n- those inherited from Model (intermediate inheritance works),\n- the ones whose type is a function,\n- the ones manually excluded using the second parameter.\n- the ones branded using {@link NonAttribute}\n\nIt cannot detect whether something is a getter or not, you should use the `Excluded`\nparameter to exclude getter & setters from the attribute list." }, "S4instanceBrandingResponse": { "$ref": "#/definitions/InferAttributes_s4InstanceBranding_" }, "UpdateInstanceBrandingBody": { "properties": { "title": { "type": "string", "x-nullable": true }, "primaryColor": { "type": "string", "x-nullable": true }, "logoSmall": { "type": "string", "x-nullable": true }, "logoMedium": { "type": "string", "x-nullable": true }, "logoLarge": { "type": "string", "x-nullable": true }, "favicon": { "type": "string", "x-nullable": true } }, "required": [ "title", "primaryColor", "logoSmall", "logoMedium", "logoLarge", "favicon" ], "type": "object" }, "InstagramAccountDto": { "properties": { "instagramProfileId": { "type": "number", "format": "double" }, "instagramExternalId": { "type": "string", "x-nullable": true }, "handle": { "type": "string", "x-nullable": true }, "fullName": { "type": "string", "x-nullable": true }, "bio": { "type": "string", "x-nullable": true }, "profilePicture": { "type": "string", "x-nullable": true }, "followersCount": { "type": "number", "format": "double", "x-nullable": true }, "followingCount": { "type": "number", "format": "double", "x-nullable": true }, "mediaCount": { "type": "number", "format": "double", "x-nullable": true }, "engagementRate": { "type": "number", "format": "double", "x-nullable": true }, "averageEngagements": { "type": "number", "format": "double", "x-nullable": true }, "averageLikes": { "type": "number", "format": "double", "x-nullable": true }, "averageComments": { "type": "number", "format": "double", "x-nullable": true }, "isPrivate": { "type": "boolean", "x-nullable": true }, "isBusiness": { "type": "boolean", "x-nullable": true }, "createdAt": { "type": "string", "x-nullable": true }, "updatedAt": { "type": "string", "x-nullable": true } }, "required": [ "instagramProfileId", "instagramExternalId", "handle", "fullName", "bio", "profilePicture", "followersCount", "followingCount", "mediaCount", "engagementRate", "averageEngagements", "averageLikes", "averageComments", "isPrivate", "isBusiness", "createdAt", "updatedAt" ], "type": "object", "additionalProperties": false }, "FacebookActiveProfileDto": { "properties": { "facebookExternalId": { "type": "string" }, "communityId": { "type": "string", "x-nullable": true }, "name": { "type": "string", "x-nullable": true }, "link": { "type": "string", "x-nullable": true }, "picture": { "type": "string", "x-nullable": true }, "type": { "type": "string", "enum": [ "account", "page" ], "x-nullable": false }, "reach": { "type": "number", "format": "double", "x-nullable": true }, "engagementRate": { "type": "string", "x-nullable": true }, "averageEngagements": { "type": "number", "format": "double", "x-nullable": true }, "averageLikes": { "type": "number", "format": "double", "x-nullable": true }, "averageComments": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "facebookExternalId", "communityId", "name", "link", "picture", "type", "reach", "engagementRate", "averageEngagements", "averageLikes", "averageComments" ], "type": "object", "additionalProperties": false }, "MembershipContactInfoDto": { "properties": { "fullName": { "type": "string", "x-nullable": true }, "email": { "type": "string", "x-nullable": true }, "phone": { "type": "string", "x-nullable": true }, "street": { "type": "string", "x-nullable": true }, "apt": { "type": "string", "x-nullable": true }, "city": { "type": "string", "x-nullable": true }, "state": { "type": "string", "x-nullable": true }, "zip": { "type": "string", "x-nullable": true }, "country": { "type": "string", "x-nullable": true }, "gender": { "type": "string", "x-nullable": true }, "birthday": { "type": "string", "x-nullable": true } }, "required": [ "fullName", "email", "phone", "street", "apt", "city", "state", "zip", "country", "gender", "birthday" ], "type": "object", "additionalProperties": false }, "MembershipDataPointDto": { "properties": { "key": { "type": "string", "x-nullable": true }, "value": { "type": "string" } }, "required": [ "key", "value" ], "type": "object", "additionalProperties": false }, "MembershipCostAndPerformanceDto": { "properties": { "cpe": { "type": "number", "format": "double", "x-nullable": true }, "cpm": { "type": "number", "format": "double", "x-nullable": true }, "cpp": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "cpe", "cpm", "cpp" ], "type": "object", "additionalProperties": false }, "MemberSelectedEthnicityDto": { "properties": { "ethnicGroup": { "type": "string" }, "ethnicGroupDescription": { "type": "string" } }, "required": [ "ethnicGroup", "ethnicGroupDescription" ], "type": "object", "additionalProperties": false }, "AppMembershipDto": { "properties": { "id": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "x-nullable": true }, "lifetimeClicks": { "type": "number", "format": "double" }, "lifetimeConversions": { "type": "number", "format": "double" }, "lifetimeConversionsValue": { "type": "number", "format": "double" }, "totalImpressions": { "type": "number", "format": "double" }, "mostRecentActivationDate": { "type": "string", "x-nullable": true }, "contactInfo": { "type": "object" }, "dataPoints": { "items": { "$ref": "#/definitions/MembershipDataPointDto" }, "type": "array" }, "costAndPerformance": { "type": "object" }, "memberSelectedEthnicities": { "items": { "$ref": "#/definitions/MemberSelectedEthnicityDto" }, "type": "array" } }, "required": [ "id", "communityId", "status", "createdAt", "lifetimeClicks", "lifetimeConversions", "lifetimeConversionsValue", "totalImpressions", "mostRecentActivationDate", "contactInfo", "dataPoints", "costAndPerformance", "memberSelectedEthnicities" ], "type": "object", "additionalProperties": false }, "GlobalUserSummaryDto": { "description": "Lightweight representation of a GlobalUserSummaryView row with included associations,\nreturned by the search-indexing endpoint for the influence search pipeline.", "properties": { "id": { "type": "number", "format": "double" }, "deleted": { "type": "boolean" }, "email": { "type": "string", "x-nullable": true }, "fullName": { "type": "string", "x-nullable": true }, "gender": { "type": "string", "x-nullable": true }, "birthday": { "type": "string", "x-nullable": true }, "city": { "type": "string", "x-nullable": true }, "state": { "type": "string", "x-nullable": true }, "country": { "type": "string", "x-nullable": true }, "instagramHandle": { "type": "string", "x-nullable": true }, "loadSource": { "type": "string", "x-nullable": true }, "lastRefreshedAt": { "type": "string", "x-nullable": true }, "audiencePercentageFemale": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_13_17": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_18_24": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_25_34": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_35_44": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_45_54": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_55_64": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_65_plus": { "type": "number", "format": "double", "x-nullable": true }, "audiencePredominantAgeRange": { "type": "string", "x-nullable": true }, "audiencePredominantCity": { "type": "string", "x-nullable": true }, "audiencePredominantCountry": { "type": "string", "x-nullable": true }, "audienceFraudLevel": { "type": "object" }, "audienceFakeFollowersLevel": { "type": "object" }, "audienceFakeEngagersLevel": { "type": "object" }, "nudityLevel": { "type": "object" }, "profanityLevel": { "type": "object" }, "violenceLevel": { "type": "object" }, "publicUserSummary": { "type": "boolean" }, "topicIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "listIds": { "items": { "type": "number", "format": "double" }, "type": "array" }, "instagramAccount": { "type": "object" }, "facebookActiveProfiles": { "items": { "$ref": "#/definitions/FacebookActiveProfileDto" }, "type": "array" }, "appMemberships": { "items": { "$ref": "#/definitions/AppMembershipDto" }, "type": "array" } }, "required": [ "id", "deleted", "email", "fullName", "gender", "birthday", "city", "state", "country", "instagramHandle", "loadSource", "lastRefreshedAt", "audiencePercentageFemale", "audiencePercentage_13_17", "audiencePercentage_18_24", "audiencePercentage_25_34", "audiencePercentage_35_44", "audiencePercentage_45_54", "audiencePercentage_55_64", "audiencePercentage_65_plus", "audiencePredominantAgeRange", "audiencePredominantCity", "audiencePredominantCountry", "audienceFraudLevel", "audienceFakeFollowersLevel", "audienceFakeEngagersLevel", "nudityLevel", "profanityLevel", "violenceLevel", "publicUserSummary", "topicIds", "listIds", "instagramAccount", "facebookActiveProfiles", "appMemberships" ], "type": "object", "additionalProperties": false }, "TalentManagerDto": { "description": "A talent manager associated with a global user, returned by the\nsearch-indexing talent-managers endpoint. Mirrors the fields the\ninfluence index needs (`talentManagers` sub-object).", "properties": { "email": { "type": "string" }, "firstName": { "type": "string", "x-nullable": true }, "lastName": { "type": "string", "x-nullable": true } }, "required": [ "email", "firstName", "lastName" ], "type": "object", "additionalProperties": false }, "InstagramPreviewPostDto": { "description": "Raw Instagram preview post as stored, returned by the\ninstagram-preview-posts endpoint. Unformatted — the influence\npipeline shapes these into the index's `instagramPost` field.", "properties": { "caption": { "type": "string", "x-nullable": true }, "comments": { "type": "number", "format": "double", "x-nullable": true }, "date": { "type": "string", "x-nullable": true }, "displayUrl": { "type": "string", "x-nullable": true }, "hashtags": { "items": { "type": "string" }, "type": "array", "x-nullable": true }, "likes": { "type": "number", "format": "double", "x-nullable": true }, "location": { "type": "string", "x-nullable": true }, "mentions": { "items": { "type": "string" }, "type": "array", "x-nullable": true }, "shortcode": { "type": "string", "x-nullable": true }, "sponsored": { "type": "boolean", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "InstagramPreviewPostsRequestDto": { "description": "Request body for the instagram-preview-posts endpoint. The caller\n(influence search-indexing pipeline) extracts these identifiers from\nthe CDS creator profile so SAPI doesn't re-resolve it.", "properties": { "instagramExternalId": { "type": "string", "x-nullable": true }, "platformId": { "type": "string", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "TiktokPreviewPostDto": { "description": "TikTok preview post from the tiktok-service (TTCM), returned by the\ntiktok-preview-posts endpoint. This endpoint serves the TTCM source\nonly — the influence pipeline already reads the CDS social presence\nand calls here just as a fallback when CDS carries no posts.\n\n`postedTime` is epoch milliseconds. TTCM stores it as ms × 1000, so it\ncomes through very large; the influence pipeline divides it back down\n(mirrors `handleLargeDateTime`).", "properties": { "likes": { "type": "number", "format": "double" }, "comments": { "type": "number", "format": "double" }, "views": { "type": "number", "format": "double" }, "shares": { "type": "number", "format": "double" }, "caption": { "type": "string" }, "thumbnailUrl": { "type": "string", "x-nullable": true }, "postedTime": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "likes", "comments", "views", "shares", "caption", "thumbnailUrl", "postedTime" ], "type": "object", "additionalProperties": false }, "GlobalPerformanceContentDto": { "description": "Content-performance subset of the analytics creator-performance\nresponse the indexing pipeline needs for `globalPerformanceMetrics`.", "properties": { "cpe": { "type": "number", "format": "double", "x-nullable": true }, "cpm": { "type": "number", "format": "double", "x-nullable": true }, "cpp": { "type": "number", "format": "double", "x-nullable": true }, "estimatedValueGenerated": { "type": "number", "format": "double", "x-nullable": true }, "estimatedReturnOnInvestment": { "type": "number", "format": "double", "x-nullable": true }, "activatedInstances": { "type": "number", "format": "double", "x-nullable": true }, "activatedCampaigns": { "type": "number", "format": "double", "x-nullable": true }, "numberOfActivations": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "cpe", "cpm", "cpp", "estimatedValueGenerated", "estimatedReturnOnInvestment", "activatedInstances", "activatedCampaigns", "numberOfActivations" ], "type": "object", "additionalProperties": false }, "GlobalPerformanceAffiliateDto": { "description": "Affiliate-performance subset (Mavely link metrics) the indexing\npipeline needs for `globalPerformanceMetrics`.", "properties": { "mavelyLinksConversionRate": { "type": "number", "format": "double", "x-nullable": true }, "mavelyLinksConversions": { "type": "number", "format": "double", "x-nullable": true }, "mavelyLinksSales": { "type": "number", "format": "double", "x-nullable": true }, "mavelyLinksRoi": { "type": "number", "format": "double", "x-nullable": true }, "costPerMavelyLinkClick": { "type": "number", "format": "double", "x-nullable": true }, "hasTrackingOrAffiliateLinksData": { "type": "boolean" } }, "required": [ "mavelyLinksConversionRate", "mavelyLinksConversions", "mavelyLinksSales", "mavelyLinksRoi", "costPerMavelyLinkClick", "hasTrackingOrAffiliateLinksData" ], "type": "object", "additionalProperties": false }, "GlobalPerformanceMetricsResponseDto": { "description": "Global performance metrics from the analytics service, returned by the\nperformance-metrics endpoint. A thin passthrough of\n`AnalyticsService.getGlobalPerformanceMetricsByGlobalUserIds` — the\nindexing pipeline maps these onto the document's\n`globalPerformanceMetrics` block and derives the rest.", "properties": { "contentPerformance": { "$ref": "#/definitions/GlobalPerformanceContentDto" }, "affiliatePerformance": { "$ref": "#/definitions/GlobalPerformanceAffiliateDto" } }, "required": [ "contentPerformance", "affiliatePerformance" ], "type": "object", "additionalProperties": false }, "IncentiveRangeDto": { "description": "A recommended payment range from the incentive-advisor model.", "properties": { "low": { "type": "number", "format": "double", "x-nullable": true }, "middle": { "type": "number", "format": "double", "x-nullable": true }, "high": { "type": "number", "format": "double", "x-nullable": true } }, "required": [ "low", "middle", "high" ], "type": "object", "additionalProperties": false }, "IncentiveRecommendationsDto": { "description": "Incentive-advisor recommendations, returned by the incentive-advisor\nendpoint. Mirrors `IncentiveAdvisorV2Service.predict`. The indexing\npipeline uses `igPost.middle` as the sponsored cost-per-post.", "properties": { "igReel": { "$ref": "#/definitions/IncentiveRangeDto" }, "igPost": { "$ref": "#/definitions/IncentiveRangeDto" }, "igStory": { "$ref": "#/definitions/IncentiveRangeDto" }, "ttPost": { "$ref": "#/definitions/IncentiveRangeDto" } }, "required": [ "igReel", "igPost", "igStory", "ttPost" ], "type": "object", "additionalProperties": false }, "IncentiveAdvisorRequestDto": { "description": "Request body for the incentive-advisor endpoint. The caller passes the\nfollower counts it already resolved from CDS so SAPI does no CDS work —\nit just invokes the SageMaker incentive-advisor model.", "properties": { "igFollowers": { "type": "number", "format": "double", "x-nullable": true }, "ttFollowers": { "type": "number", "format": "double", "x-nullable": true } }, "type": "object", "additionalProperties": false }, "AudienceFollowersBrandAffinity": { "properties": { "affinity_name": { "type": "string" }, "affinity_value": { "type": "number", "format": "double" }, "affinity_weight": { "type": "number", "format": "double" } }, "required": [ "affinity_name", "affinity_value", "affinity_weight" ], "type": "object", "additionalProperties": false }, "AudienceFollowersTopInterest": { "properties": { "interest_affinity": { "type": "number", "format": "double" }, "interest_name": { "type": "string" }, "interest_weight": { "type": "number", "format": "double" } }, "required": [ "interest_affinity", "interest_name", "interest_weight" ], "type": "object", "additionalProperties": false }, "AudienceStateDistributionNumber": { "properties": { "state_name": { "type": "string" }, "state_numbers": { "type": "number", "format": "double" } }, "required": [ "state_name", "state_numbers" ], "type": "object", "additionalProperties": false }, "AudienceStateDistributionPercentage": { "properties": { "state_name": { "type": "string" }, "state_weight": { "type": "number", "format": "double" } }, "required": [ "state_name", "state_weight" ], "type": "object", "additionalProperties": false }, "CreatorTopHashtag": { "properties": { "hashtag_weight": { "type": "number", "format": "double" }, "tag_name": { "type": "string" } }, "required": [ "hashtag_weight", "tag_name" ], "type": "object", "additionalProperties": false }, "SocialProfile": { "properties": { "audience_followers_brand_affinity": { "items": { "$ref": "#/definitions/AudienceFollowersBrandAffinity" }, "type": "array" }, "audience_followers_top_interests": { "items": { "$ref": "#/definitions/AudienceFollowersTopInterest" }, "type": "array" }, "audience_state_distribution_numbers": { "items": { "$ref": "#/definitions/AudienceStateDistributionNumber" }, "type": "array" }, "audience_state_distribution_percentage": { "items": { "$ref": "#/definitions/AudienceStateDistributionPercentage" }, "type": "array" }, "avg_comments": { "type": "string" }, "avg_likes": { "type": "string" }, "creator_age_group": { "type": "string" }, "creator_country_name": { "type": "string" }, "creator_state_name": { "type": "string" }, "creator_top_hashtags": { "items": { "$ref": "#/definitions/CreatorTopHashtag" }, "type": "array" }, "creator_top_interests": { "items": { "additionalProperties": true }, "type": "array" }, "engagements": { "type": "string" }, "engagement_rate": { "type": "number", "format": "double" }, "followers": { "type": "string" }, "followers_age_percentage_13_to_17": { "type": "number", "format": "double" }, "followers_age_percentage_18_to_24": { "type": "number", "format": "double" }, "followers_age_percentage_25_to_34": { "type": "number", "format": "double" }, "followers_age_percentage_35_to_44": { "type": "number", "format": "double" }, "followers_age_percentage_45_to_64": { "type": "number", "format": "double" }, "followers_age_percentage_65_plus": { "type": "number", "format": "double" }, "followers_female_percentage": { "type": "number", "format": "double" }, "followers_influencers_audience_percentage": { "type": "number", "format": "double" }, "followers_male_percentage": { "type": "number", "format": "double" }, "followers_mass_followers_audience_percentage": { "type": "number", "format": "double" }, "followers_real_audience_percentage": { "type": "number", "format": "double" }, "gender": { "type": "string" }, "is_collectiveVoiceHQ_creator": { "type": "string" }, "is_ltk_creator": { "type": "string" }, "is_magicLinks_creator": { "type": "string" }, "is_shopMy_creator": { "type": "string" }, "posts_count": { "type": "string" }, "social_channel": { "type": "string" }, "social_handle": { "type": "string" } }, "required": [ "audience_followers_brand_affinity", "audience_followers_top_interests", "audience_state_distribution_numbers", "audience_state_distribution_percentage", "avg_comments", "avg_likes", "creator_age_group", "creator_country_name", "creator_state_name", "creator_top_hashtags", "creator_top_interests", "engagements", "engagement_rate", "followers", "followers_age_percentage_13_to_17", "followers_age_percentage_18_to_24", "followers_age_percentage_25_to_34", "followers_age_percentage_35_to_44", "followers_age_percentage_45_to_64", "followers_age_percentage_65_plus", "followers_female_percentage", "followers_influencers_audience_percentage", "followers_male_percentage", "followers_mass_followers_audience_percentage", "followers_real_audience_percentage", "gender", "is_collectiveVoiceHQ_creator", "is_ltk_creator", "is_magicLinks_creator", "is_shopMy_creator", "posts_count", "social_channel", "social_handle" ], "type": "object", "additionalProperties": false }, "DynamoOnSocialInstagramProfile": { "properties": { "social_profile": { "$ref": "#/definitions/SocialProfile" }, "handle": { "type": "string" } }, "required": [ "social_profile", "handle" ], "type": "object" }, "AudienceDemographicsDynamoDto": { "description": "Raw DynamoDB audience-demographics blobs for the influence indexing\npipeline: the DemographicsPro item (all platforms, keyed by globalUserId)\nand the OnSocial Instagram profile (keyed by handle). Returned verbatim —\nno CDS, no graph capping, no ES-field shaping. The pipeline merges these\nwith its own CDS/official data. Either blob is null when absent.", "properties": { "globalUserId": { "type": "number", "format": "double" }, "demoPro": { "type": "object" }, "onSocial": { "type": "object" } }, "required": [ "globalUserId", "demoPro", "onSocial" ], "type": "object", "additionalProperties": false }, "LiInstagramAudienceProfileDto": { "description": "Single-value \"official\" IG audience fields off the LI InstagramProfile row.", "properties": { "handle": { "type": "string", "x-nullable": true }, "followersCount": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentageFemale": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_13_17": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_18_24": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_25_34": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_35_44": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_45_54": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_55_64": { "type": "number", "format": "double", "x-nullable": true }, "audiencePercentage_65_plus": { "type": "number", "format": "double", "x-nullable": true }, "audiencePredominantAgeRange": { "type": "string", "x-nullable": true }, "audiencePredominantCity": { "type": "string", "x-nullable": true }, "audiencePredominantCountry": { "type": "string", "x-nullable": true } }, "required": [ "handle", "followersCount", "audiencePercentageFemale", "audiencePercentage_13_17", "audiencePercentage_18_24", "audiencePercentage_25_34", "audiencePercentage_35_44", "audiencePercentage_45_54", "audiencePercentage_55_64", "audiencePercentage_65_plus", "audiencePredominantAgeRange", "audiencePredominantCity", "audiencePredominantCountry" ], "type": "object", "additionalProperties": false }, "AudienceDemographicsLiDto": { "description": "Raw Instagram audience data from the LI (splashscore MySQL) for the influence\nindexing pipeline: the active profile's single-value audience fields + the\ncity/country breakdown rows. No CDS, no shaping. The pipeline uses this only\nas a fallback when the CDS presence lacks the official IG audience/locations.\n`profile` is null (and the arrays empty) when the user has no active IG profile.", "properties": { "globalUserId": { "type": "number", "format": "double" }, "instagramProfileId": { "type": "number", "format": "double", "x-nullable": true }, "profile": { "type": "object" }, "city": { "items": { "properties": { "percentage": { "type": "number", "format": "double", "x-nullable": true }, "count": { "type": "number", "format": "double", "x-nullable": true }, "cityState": { "type": "string", "x-nullable": true }, "state": { "type": "string", "x-nullable": true }, "city": { "type": "string", "x-nullable": true } }, "required": [ "percentage", "count", "cityState", "state", "city" ], "type": "object" }, "type": "array" }, "country": { "items": { "properties": { "percentage": { "type": "number", "format": "double", "x-nullable": true }, "count": { "type": "number", "format": "double", "x-nullable": true }, "isoCode": { "type": "string", "x-nullable": true }, "country": { "type": "string", "x-nullable": true } }, "required": [ "percentage", "count", "isoCode", "country" ], "type": "object" }, "type": "array" } }, "required": [ "globalUserId", "instagramProfileId", "profile", "city", "country" ], "type": "object", "additionalProperties": false }, "CreateShareableLinksVisitorBody": { "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "cipher": { "type": "string" }, "dashboardType": { "type": "string", "x-nullable": true } }, "required": [ "firstName", "lastName", "email", "cipher" ], "type": "object", "additionalProperties": false }, "ShareableLinksVisitorResponse": { "properties": { "id": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "sharedCipherId": { "type": "number", "format": "double" }, "communityId": { "type": "string", "x-nullable": true }, "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "dashboardType": { "type": "string", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "id", "firstName", "lastName", "email", "sharedCipherId", "communityId", "actionGroupId", "dashboardType", "createdAt", "updatedAt" ], "type": "object", "additionalProperties": false }, "ShareableLinksVisitorsListResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/ShareableLinksVisitorResponse" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "SharedCipherPostResponse": { "properties": { "cipher": { "type": "string" }, "version": { "type": "string" } }, "required": [ "cipher", "version" ], "type": "object", "additionalProperties": false }, "SharedCipherPostBody": { "properties": { "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "options": { "additionalProperties": false, "type": "object" }, "expiresAt": { "type": "string", "x-nullable": true, "description": "ISO 8601 timestamp. Null or omitted means the link never expires." } }, "type": "object", "additionalProperties": false }, "DBSharedCipher": { "properties": { "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "communityId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "options": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string" } }, "required": [ "communityId", "createdAt", "id", "updatedAt", "version" ], "type": "object", "additionalProperties": false }, "Pick_DBSharedCipher.Exclude_keyofDBSharedCipher.options__": { "properties": { "id": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "actionGroupId": { "type": "number", "format": "double", "x-nullable": true }, "communityId": { "type": "string" }, "createdBy": { "type": "number", "format": "double" }, "expiresAt": { "type": "string", "format": "date-time", "x-nullable": true }, "version": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "communityId", "version" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_DBSharedCipher.options_": { "$ref": "#/definitions/Pick_DBSharedCipher.Exclude_keyofDBSharedCipher.options__", "description": "Construct a type with the properties of T except for those in type K." }, "SharedCipherWithOptions": { "type": "object", "properties": {} }, "SharedCipher": { "type": "object" }, "SharedCipherGetResponse": { "$ref": "#/definitions/SharedCipher" }, "SharedLinkExpiredError": { "properties": { "message": { "type": "string", "enum": [ "This shared link has expired." ], "x-nullable": false }, "details": { "properties": {}, "additionalProperties": { "additionalProperties": true }, "type": "object" } }, "required": [ "message", "details" ], "type": "object", "additionalProperties": false }, "SharedCipherWithOptionsAndCipher": { "type": "object", "properties": {} }, "SharedCiphersGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/SharedCipherWithOptionsAndCipher" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "SharedCipherPutResponse": {}, "SharedCipherPutBody": { "properties": { "id": { "type": "number", "format": "double" }, "options": { "additionalProperties": false, "type": "object" }, "expiresAt": { "type": "string", "x-nullable": true, "description": "ISO 8601 timestamp. Null means the link never expires." } }, "required": [ "options" ], "type": "object", "additionalProperties": false }, "Pick_ShopifyAccountResponse.Exclude_keyofShopifyAccountResponse.shopifyAccessToken__": { "properties": { "id": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "communityId": { "type": "string" }, "shopName": { "type": "string" } }, "required": [ "id", "createdAt", "updatedAt", "communityId", "shopName" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_ShopifyAccountResponse.shopifyAccessToken_": { "$ref": "#/definitions/Pick_ShopifyAccountResponse.Exclude_keyofShopifyAccountResponse.shopifyAccessToken__", "description": "Construct a type with the properties of T except for those in type K." }, "ShopifyAccountResponse": { "properties": { "updatedAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "shopifyAccessToken": { "type": "string" }, "shopName": { "type": "string" }, "communityId": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "updatedAt", "createdAt", "shopifyAccessToken", "shopName", "communityId", "id" ], "type": "object" }, "CreateShopifyAccountData": { "properties": { "communityId": { "type": "string" }, "shopName": { "type": "string" }, "apiKey": { "type": "string" }, "shopifyAccessToken": { "type": "string" } }, "required": [ "communityId", "shopName", "shopifyAccessToken" ], "type": "object", "additionalProperties": false }, "UninstallShopifyRequest": { "properties": { "shopId": { "type": "number", "format": "double" } }, "required": [ "shopId" ], "type": "object", "additionalProperties": false }, "ConnectShopifyAccountBody": { "properties": { "token": { "type": "string" }, "shop": { "type": "string" } }, "required": [ "token", "shop" ], "type": "object", "additionalProperties": false }, "CouponRestriction": { "type": "object" }, "ShopifyDiscount": { "properties": { "codeDiscount": { "type": "object", "properties": {} }, "id": { "type": "number", "format": "double" } }, "required": [ "codeDiscount", "id" ], "type": "object" }, "SlowMigrationGetResponse": { "properties": { "requiredActions": { "items": { "type": "string" }, "type": "array" }, "groups": { "items": { "type": "string" }, "type": "array" }, "username": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "lastName": { "type": "string" }, "firstName": { "type": "string" }, "enabled": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "email": { "type": "string" }, "attributes": { "properties": {}, "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" } }, "required": [ "requiredActions", "groups", "username", "roles", "lastName", "firstName", "enabled", "emailVerified", "email", "attributes" ], "type": "object" }, "ValidatePasswordBody": { "properties": { "password": { "type": "string" } }, "required": [ "password" ], "type": "object" }, "RefreshSnapchatContentResponse": { "properties": { "result": { "type": "string" } }, "required": [ "result" ], "type": "object" }, "Subscriber": { "properties": { "id": { "type": "string" }, "instanceKeyname": { "type": "string" }, "isEnabled": { "type": "boolean" }, "token": { "type": "string" }, "url": { "type": "string" } }, "required": [ "id", "instanceKeyname", "isEnabled", "token", "url" ], "type": "object", "additionalProperties": false }, "UpdateSubscriberBody": { "properties": { "isEnabled": { "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object", "additionalProperties": false }, "CreateSubscriberBody": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "SubscriberPingResponse": { "properties": { "testResult": { "type": "string", "enum": [ "SUCCESS", "SUBSCRIBER_NOT_FOUND", "SUBSCRIBER_DISABLED", "FAILURE" ], "x-nullable": false } }, "required": [ "testResult" ], "type": "object", "additionalProperties": false }, "SurveyResponseSummary": { "properties": { "id": { "type": "number", "format": "double" }, "questionText": { "type": "string" }, "order": { "type": "number", "format": "double" }, "total": { "type": "number", "format": "double" }, "options": { "items": { "properties": { "percentage": { "type": "number", "format": "double" }, "count": { "type": "number", "format": "double" }, "value": { "type": "string" } }, "required": [ "percentage", "count", "value" ], "type": "object" }, "type": "array" } }, "required": [ "id", "questionText", "order", "total", "options" ], "type": "object", "additionalProperties": false }, "SurveyResponse": { "properties": { "age": { "type": "number", "format": "double" }, "birthday": { "type": "string" }, "city": { "type": "string" }, "communityId": { "type": "string" }, "country": { "type": "string" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "fullName": { "type": "string" }, "gender": { "type": "string" }, "genderDescription": { "type": "string" }, "id": { "type": "number", "format": "double" }, "instagramHandle": { "type": "string" }, "lastName": { "type": "string" }, "lifetimeImpressions": { "type": "number", "format": "double" }, "membershipId": { "type": "number", "format": "double" }, "phone": { "type": "string" }, "profilePicture": { "type": "string" }, "questionResponses": { "$ref": "#/definitions/Record_string.any_" }, "state": { "type": "string" }, "status": { "type": "string" }, "street": { "type": "string" }, "zip": { "type": "string" } }, "required": [ "age", "birthday", "city", "communityId", "country", "createdAt", "email", "firstName", "fullName", "gender", "genderDescription", "id", "instagramHandle", "lastName", "lifetimeImpressions", "membershipId", "phone", "profilePicture", "questionResponses", "state", "status", "street", "zip" ], "type": "object", "additionalProperties": false }, "Pick_ReviewForm.Exclude_keyofReviewForm.responses-or-product__": { "properties": { "id": { "type": "number", "format": "double" }, "reviewProductId": { "type": "number", "format": "double" }, "action": { "$ref": "#/definitions/Action" }, "questions": { "items": { "$ref": "#/definitions/Question" }, "type": "array" }, "incentivized": { "type": "boolean" } }, "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_ReviewForm.responses-or-product_": { "$ref": "#/definitions/Pick_ReviewForm.Exclude_keyofReviewForm.responses-or-product__", "description": "Construct a type with the properties of T except for those in type K." }, "GetSurveyByActionIdResponse": { "$ref": "#/definitions/Omit_ReviewForm.responses-or-product_" }, "TikTokCampaignOrBrandInfoFieldsResponse": { "$ref": "#/definitions/TikTokBrandFields" }, "CreateTikTokCampaignFieldsOrBrandInfoBody": { "$ref": "#/definitions/TikTokBrandFields" }, "PutTikTokContentActivationRequestBody": { "properties": { "audienceAgeDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceAgeDistribution" }, "type": "array", "x-nullable": true }, "audienceCountriesDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceCountriesDistribution" }, "type": "array", "x-nullable": true }, "audienceGendersDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceGendersDistribution" }, "type": "array", "x-nullable": true }, "audienceInterestDistribution": { "items": { "$ref": "#/definitions/TikTokAudienceInterestDistribution" }, "type": "array", "x-nullable": true }, "caption": { "type": "string" }, "comments": { "type": "number", "format": "double" }, "commentsOrganic": { "type": "number", "format": "double" }, "commentsPaid": { "type": "number", "format": "double" }, "engagementCount": { "type": "number", "format": "double" }, "impressions": { "type": "number", "format": "double" }, "impressionsSource": { "type": "string" }, "likes": { "type": "number", "format": "double" }, "likesOrganic": { "type": "number", "format": "double" }, "likesPaid": { "type": "number", "format": "double" }, "reach": { "type": "number", "format": "double", "x-nullable": true }, "shares": { "type": "number", "format": "double" }, "sharesOrganic": { "type": "number", "format": "double" }, "sharesPaid": { "type": "number", "format": "double" }, "link": { "type": "string" }, "totalPlayTime": { "type": "number", "format": "double" }, "videoCompletionRate": { "type": "number", "format": "double" }, "videoViewsBySource": { "items": { "$ref": "#/definitions/TikTokVideoViewsBySource" }, "type": "array", "x-nullable": true }, "videoViews": { "type": "number", "format": "double" }, "videoViewsOrganic": { "type": "number", "format": "double" }, "videoViewsPaid": { "type": "number", "format": "double" } }, "required": [ "comments", "likes", "shares" ], "type": "object", "additionalProperties": false }, "TopicIdSet": { "properties": { "topicIds": { "items": { "type": "string" }, "type": "array" } }, "required": [ "topicIds" ], "type": "object", "additionalProperties": false }, "ResponseBody_TopicIdSet_": { "properties": { "data": { "$ref": "#/definitions/TopicIdSet" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "ResponseMetadataModel": { "properties": { "limit": { "type": "number", "format": "double" }, "offset": { "type": "number", "format": "double" }, "status": { "type": "string", "enum": [ "failure", "success" ], "x-nullable": false }, "totalCount": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "GetTopicsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/Topic" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMetadataModel" } }, "required": [ "data", "meta" ], "type": "object", "additionalProperties": false }, "TrackingLinksGetResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/TrackingLink" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMetadata" } }, "type": "object", "additionalProperties": false }, "EditTrackingLinkBody": { "properties": { "title": { "type": "string" }, "destinationUrl": { "type": "string" }, "providerCode": { "type": "string" }, "communityId": { "type": "string" } }, "required": [ "title", "destinationUrl", "providerCode", "communityId" ], "type": "object", "additionalProperties": false }, "Locale": { "properties": { "language": { "type": "string" }, "code": { "type": "string" } }, "required": [ "language", "code" ], "type": "object", "additionalProperties": false }, "Components.Schemas.PurgeQueueResponse": { "properties": { "success": { "type": "boolean" }, "queueName": { "type": "string" }, "message": { "type": "string" } }, "type": "object", "additionalProperties": false }, "TikTokQueueType": { "enum": [ "media-binder", "media-updater", "creator-updater" ], "type": "string" }, "Components.Schemas.QueueStatsResponse": { "properties": { "mediaBinderQueue": { "$ref": "#/definitions/QueueStats" }, "mediaUpdaterQueue": { "$ref": "#/definitions/QueueStats" }, "creatorUpdaterQueue": { "$ref": "#/definitions/QueueStats" } }, "type": "object", "additionalProperties": false }, "SendGridMailerEventStatus": { "enum": [ "account_status_change", "bounce", "click", "deferred", "delivered", "dropped", "group_resubscribe", "group_unsubscribe", "open", "processed", "spamreport", "unsubscribe" ], "type": "string" }, "AccountInvitationDomain": { "properties": { "communityId": { "type": "string" }, "createdAt": { "type": "string" }, "email": { "type": "string" }, "mailerStatus": { "type": "object" }, "expiresAt": { "type": "string" }, "fulfilledByAccountId": { "type": "number", "format": "double", "x-nullable": true }, "id": { "type": "number", "format": "double" }, "inviteeRoleId": { "type": "number", "format": "double" }, "updatedAt": { "type": "string" } }, "required": [ "communityId", "createdAt", "email", "mailerStatus", "expiresAt", "fulfilledByAccountId", "id", "inviteeRoleId", "updatedAt" ], "type": "object", "additionalProperties": false }, "ResponseBody_AccountInvitationDomain-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/AccountInvitationDomain" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "AccountActivationPostRequestBody": { "properties": { "communityId": { "type": "string" }, "email": { "type": "string" }, "inviteeRoleId": { "type": "number", "format": "double" } }, "required": [ "communityId", "email", "inviteeRoleId" ], "type": "object", "additionalProperties": false }, "AccountActivationPutRequestBody": { "properties": { "email": { "type": "string" }, "inviteeRoleId": { "type": "number", "format": "double" } }, "type": "object", "additionalProperties": false }, "Role": { "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name", "id", "description" ], "type": "object" }, "CommunityRole": { "properties": { "roleId": { "type": "number", "format": "double" }, "communityId": { "type": "string" } }, "required": [ "roleId", "communityId" ], "type": "object" }, "AdministratorAccount": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "object" }, "image": { "type": "string", "x-nullable": true }, "last_name": { "type": "string" }, "roles": { "items": { "$ref": "#/definitions/Role" }, "type": "array", "x-deprecated": true }, "communityRoles": { "items": { "$ref": "#/definitions/CommunityRole" }, "type": "array" } }, "required": [ "email", "id" ], "type": "object", "additionalProperties": false }, "ResponseBody_AdministratorAccount-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/AdministratorAccount" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "AdministratorAccountGetResponse": { "properties": { "lastName": { "type": "string" }, "firstName": { "type": "string" }, "email": { "type": "string" }, "attributes": { "properties": {}, "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object" } }, "required": [ "lastName", "firstName", "email", "attributes" ], "type": "object" }, "CommunityAdministratorAccount": { "properties": { "email": { "type": "string" }, "communityId": { "type": "string" }, "id": { "type": "object" }, "roleId": { "type": "number", "format": "double" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "image": { "type": "string", "x-nullable": true } }, "required": [ "email", "communityId", "id", "roleId" ], "type": "object", "additionalProperties": false }, "AddToCommunityPostBody": { "properties": { "accountId": { "type": "number", "format": "double" } }, "required": [ "accountId" ], "type": "object", "additionalProperties": false }, "UpdateAccountPutBody": { "properties": { "newRoleId": { "type": "number", "format": "double" } }, "required": [ "newRoleId" ], "type": "object", "additionalProperties": false }, "GlobalUserMergeSearchRequest": { "properties": { "globalUserId": { "type": "number", "format": "double" } }, "required": [ "globalUserId" ], "type": "object" }, "GlobalUserMergeRequest": { "properties": { "source": { "type": "string" }, "newId": { "type": "number", "format": "double" }, "oldId": { "type": "number", "format": "double" } }, "required": [ "newId", "oldId" ], "type": "object" }, "Pick_WebPluginConversionBody.Exclude_keyofWebPluginConversionBody.promoCode-or-orderId__": { "properties": { "communityId": { "type": "string" }, "conversionValue": { "type": "number", "format": "double" }, "conversionCode": { "type": "string" } }, "required": [ "communityId", "conversionValue", "conversionCode" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_WebPluginConversionBody.promoCode-or-orderId_": { "$ref": "#/definitions/Pick_WebPluginConversionBody.Exclude_keyofWebPluginConversionBody.promoCode-or-orderId__", "description": "Construct a type with the properties of T except for those in type K." }, "WebPluginConversionResponse": { "$ref": "#/definitions/Omit_WebPluginConversionBody.promoCode-or-orderId_" }, "ResponseBody_WebPluginConversionResponse-Array_": { "properties": { "data": { "items": { "$ref": "#/definitions/WebPluginConversionResponse" }, "type": "array" }, "meta": { "$ref": "#/definitions/ResponseMeta" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "WebPluginConversionBody": { "properties": { "orderId": { "type": "string" }, "promoCode": { "type": "string" }, "conversionValue": { "type": "number", "format": "double" }, "conversionCode": { "type": "string" }, "communityId": { "type": "string" } }, "required": [ "conversionValue", "conversionCode", "communityId" ], "type": "object" }, "Pick_DBWebPluginWidgets.Exclude_keyofDBWebPluginWidgets.id-or-createdAt-or-updatedAt-or-status__": { "properties": { "actionGroupId": { "type": "number", "format": "double" }, "communityId": { "type": "string" }, "cssSelector": { "type": "string", "x-nullable": true }, "initializationRuleType": { "type": "string" }, "targetUrl": { "type": "string", "x-nullable": true }, "urlRegexRule": { "type": "string", "x-nullable": true }, "widgetHTML": { "type": "string" }, "widgetType": { "type": "string" } }, "required": [ "actionGroupId", "communityId", "initializationRuleType", "widgetHTML", "widgetType" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_DBWebPluginWidgets.id-or-createdAt-or-updatedAt-or-status_": { "$ref": "#/definitions/Pick_DBWebPluginWidgets.Exclude_keyofDBWebPluginWidgets.id-or-createdAt-or-updatedAt-or-status__", "description": "Construct a type with the properties of T except for those in type K." }, "FilteredWidget": { "$ref": "#/definitions/Omit_DBWebPluginWidgets.id-or-createdAt-or-updatedAt-or-status_" }, "GetWebPluginWidgetsResponse": { "properties": { "data": { "items": { "$ref": "#/definitions/FilteredWidget" }, "type": "array" } }, "required": [ "data" ], "type": "object", "additionalProperties": false }, "SendGridEvent": { "properties": { "messageId": { "type": "string" }, "accountInvitationId": { "type": "string" }, "sg_event_id": { "type": "string" }, "event": { "$ref": "#/definitions/SendGridMailerEventStatus" }, "timestamp": { "type": "number", "format": "double" }, "ip": { "type": "string" }, "useragent": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string" }, "email": { "type": "string" } }, "required": [ "sg_event_id", "event", "timestamp" ], "type": "object", "additionalProperties": false }, "YotpoAppResponse": { "properties": { "name": { "type": "string", "x-nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "secretKey": { "type": "string" }, "apiKey": { "type": "string" }, "id": { "type": "number", "format": "double" } }, "required": [ "name", "createdAt", "secretKey", "apiKey", "id" ], "type": "object" }, "YotpoAppPostRequestBody": { "properties": { "secretKey": { "type": "string" }, "name": { "type": "string" }, "apiKey": { "type": "string" } }, "required": [ "secretKey", "name", "apiKey" ], "type": "object" }, "YotpoAppPostRequest": { "properties": { "data": { "$ref": "#/definitions/YotpoAppPostRequestBody" } }, "required": [ "data" ], "type": "object" }, "ActionGroupCampaignCodeResponse": { "properties": { "campaignCode": { "type": "string", "x-nullable": true } }, "required": [ "campaignCode" ], "type": "object", "additionalProperties": false }, "ActionGroupYoutubeChannelResponse": { "properties": { "channelId": { "type": "string", "x-nullable": true }, "title": { "type": "string", "x-nullable": true }, "channelHandle": { "type": "string", "x-nullable": true }, "thumbnailUri": { "type": "string", "x-nullable": true }, "source": { "type": "string", "enum": [ "overridden", "inherited", null ], "x-nullable": true }, "hasNoYoutubeChannel": { "type": "boolean" } }, "required": [ "channelId", "title", "channelHandle", "thumbnailUri", "source", "hasNoYoutubeChannel" ], "type": "object", "additionalProperties": false }, "SetYoutubeChannelRequest": { "properties": { "channelInput": { "type": "string" }, "hasNoYoutubeChannel": { "type": "boolean" } }, "type": "object", "additionalProperties": false }, "BrandChannelValidationResponse": { "properties": { "channelId": { "type": "string" }, "title": { "type": "string", "x-nullable": true }, "channelHandle": { "type": "string", "x-nullable": true }, "thumbnailUri": { "type": "string", "x-nullable": true } }, "required": [ "channelId", "title", "channelHandle", "thumbnailUri" ], "type": "object", "additionalProperties": false }, "BrandChannelValidationRequest": { "properties": { "channelInput": { "type": "string" } }, "required": [ "channelInput" ], "type": "object", "additionalProperties": false }, "BrandYoutubeChannelResponse": { "properties": { "channelId": { "type": "string", "x-nullable": true }, "title": { "type": "string", "x-nullable": true }, "channelHandle": { "type": "string", "x-nullable": true }, "thumbnailUri": { "type": "string", "x-nullable": true }, "hasNoYoutubeChannel": { "type": "boolean" } }, "required": [ "channelId", "title", "channelHandle", "thumbnailUri", "hasNoYoutubeChannel" ], "type": "object", "additionalProperties": false } }, "securityDefinitions": { "apiKey": { "type": "apiKey", "name": "api-key", "in": "header" } }, "security": [ { "apiKey": [] } ] }