{ "opencollection": "1.0.0", "info": { "name": "MAVRCK.IO", "version": "1.0.0" }, "items": [ { "info": { "name": "AnonymousIncentiveClaim", "type": "folder" }, "items": [ { "info": { "name": "Claim an incentive anonymously", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/anonymous-incentive-claim" }, "docs": "Claim an incentive anonymously" } ] }, { "info": { "name": "Points", "type": "folder" }, "items": [ { "info": { "name": "Retrieve the points history for an influencer.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/influencers/:membershipId/points-history", "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Retrieve the points history for an influencer." }, { "info": { "name": "Grant points for an influencer in a manual entry.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/influencers/:membershipId/points-history", "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Grant points for an influencer in a manual entry." } ] }, { "info": { "name": "Activations", "type": "folder" }, "items": [ { "info": { "name": "Create an activation when an action is completed by a user.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action/:actionId/activation", "params": [ { "name": "actionId", "value": "", "type": "path" }, { "name": "productExperience", "value": "", "type": "query", "description": "Tag this activation with a key denoting the experience/channel in which the user created the activation." }, { "name": "utmSource", "value": "", "type": "query" }, { "name": "utmMedium", "value": "", "type": "query" }, { "name": "utmTerm", "value": "", "type": "query" }, { "name": "utmContent", "value": "", "type": "query" }, { "name": "utmCampaign", "value": "", "type": "query" }, { "name": "iovationIdentifier", "value": "", "type": "query" } ] }, "docs": "Create an activation when an action is completed by a user." }, { "info": { "name": "Retrieve activations for an action.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action/:actionId/activations", "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "approvalStatus", "value": "", "type": "query", "description": "The approval status of an Activation." }, { "name": "actionId", "value": "", "type": "path" }, { "name": "minStars", "value": "", "type": "query", "description": "Filter on minimum stars." }, { "name": "myActivations", "value": "", "type": "query", "description": "As an influencer, select only my activations associated with the action." } ] }, "docs": "Retrieve activations for an action." }, { "info": { "name": "Fetch all activations for an action group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:actionGroupId/activations", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "query", "description": "The global user Id to filter the results by." }, { "name": "myActivations", "value": "", "type": "query", "description": "Flag permitting the influencer to view unapproved and/or-only approved activations" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "postsWithUGC", "value": "", "type": "query", "description": "Specifies whether to get UGC and require an Activation Content Summary or not." }, { "name": "network", "value": "", "type": "query", "description": "Specifies the network of an Activation." }, { "name": "userFilter", "value": "", "type": "query", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition." }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "networks", "value": "", "type": "query", "description": "Array of networks" }, { "name": "postDateAfter", "value": "", "type": "query", "description": "The activation post date is >= this date" }, { "name": "postDateBefore", "value": "", "type": "query", "description": "The activation post date is <= this date" }, { "name": "filterTagIds", "value": "", "type": "query", "description": "Array of tag ids used for searching activations" }, { "name": "tagQuantifier", "value": "", "type": "query", "description": "any or all option when searching for filterTagIds" }, { "name": "shouldExportFilenames", "value": "", "type": "query", "description": "Whether or not to export the filenames of the activations" } ] }, "docs": "Fetch all activations for an action group" }, { "info": { "name": "Fetch all activations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/activations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "approvalStatus", "value": "", "type": "query", "description": "The approval status of an Activation." }, { "name": "postsWithUGC", "value": "", "type": "query", "description": "Specifies whether to get UGC and require an Activation Content Summary or not." }, { "name": "network", "value": "", "type": "query", "description": "Specifies the network of an Activation." }, { "name": "userFilter", "value": "", "type": "query", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition." }, { "name": "networks", "value": "", "type": "query", "description": "Array of networks" }, { "name": "postDateAfter", "value": "", "type": "query", "description": "The activation post date is >= this date" }, { "name": "postDateBefore", "value": "", "type": "query", "description": "The activation post date is <= this date" }, { "name": "actionGroupId", "value": "", "type": "query", "description": "Array of action group ids" }, { "name": "showcaseMode", "value": "", "type": "query", "description": "It's showcase time!" }, { "name": "globalUserId", "value": "", "type": "query", "description": "The global user Id to filter the results by." }, { "name": "filterTagIds", "value": "", "type": "query", "description": "Array of tag ids used For searching activations" }, { "name": "tagQuantifier", "value": "", "type": "query", "description": "any or all option when searching for filterTagIds" }, { "name": "shouldExportFilenames", "value": "", "type": "query", "description": "Whether or not to export the filenames of the activations" } ] }, "docs": "Fetch all activations" }, { "info": { "name": "Create an activation manually.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/activations" }, "docs": "Create an activation manually." }, { "info": { "name": "Delete this activation and exclude its content from being re-added to the action group", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/activations", "params": [ { "name": "activationId", "value": "", "type": "query" }, { "name": "markIncomplete", "value": "", "type": "query" }, { "name": "trackingStatusId", "value": "", "type": "query" } ] }, "docs": "Delete this activation and exclude its content from being re-added to the action group" }, { "info": { "name": "Edit an activation.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/activations/:id/", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Edit an activation." }, { "info": { "name": "\n Report information about an activation or content that could not be\n programmatically activated directly to the marketer", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/self-reported-activation-notifications", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "\n Report information about an activation or content that could not be\n programmatically activated directly to the marketer" }, { "info": { "name": "Create manual activation for action.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/actions/:actionId/manual-activations/:globalUserId", "params": [ { "name": "actionId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Create manual activation for action." }, { "info": { "name": "selfReportActivation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/actions/:actionId/self-reported-activations", "params": [ { "name": "actionId", "value": "", "type": "path" } ] } }, { "info": { "name": "approveApprovalStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/activations/:activationId/approveApprovalStatus", "params": [ { "name": "activationId", "value": "", "type": "path" } ] } }, { "info": { "name": "unrejectApprovalStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/activations/:activationId/unrejectApprovalStatus", "params": [ { "name": "activationId", "value": "", "type": "path" } ] } }, { "info": { "name": "rejectApprovalStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/activations/:activationId/rejectApprovalStatus", "params": [ { "name": "activationId", "value": "", "type": "path" } ] } }, { "info": { "name": "getActivationHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/activation/history", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "campaignId", "value": "", "type": "query" }, { "name": "actionId", "value": "", "type": "query" }, { "name": "audienceId", "value": "", "type": "query" }, { "name": "actionTitle", "value": "", "type": "query" }, { "name": "actionTypes", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Communities", "type": "folder" }, "items": [ { "info": { "name": "Query Mavrck communities available to the authenticated administrator.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/communities", "params": [ { "name": "omitCurrent", "value": "", "type": "query", "description": "Omit the community that the administrator is currently authenticated into." }, { "name": "name", "value": "", "type": "query", "description": "Community name" }, { "name": "id", "value": "", "type": "query", "description": "Community Id" }, { "name": "accountId", "value": "", "type": "query", "description": "Administrator account id that can be used to filter the list down to only instances they have access to." }, { "name": "includeAll", "value": "", "type": "query", "description": "Root only parameter for requesting all communities beyond normal access" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." } ] }, "docs": "Query Mavrck communities available to the authenticated administrator." }, { "info": { "name": "Creates a community.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/communities" }, "docs": "Creates a community." }, { "info": { "name": "Retrieve a single community.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/communities/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single community." }, { "info": { "name": "getUserInCommunity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/communities/:communityId/accounts/:accountId", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateUserRoleInCommunity", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/communities/:communityId/accounts/:accountId", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "removeAccountFromCommunity", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/communities/:communityId/accounts/:accountId", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "accountId", "value": "", "type": "path" } ] } }, { "info": { "name": "addAccountToCommunity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/communities/:communityId/accounts", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Actions", "type": "folder" }, "items": [ { "info": { "name": "Create an action.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/actions", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Create an action." }, { "info": { "name": "Retrieve an individual action.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the action." } ] }, "docs": "Retrieve an individual action." }, { "info": { "name": "Update an action.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action" } ] }, "docs": "Update an action." }, { "info": { "name": "Delete an action.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/action/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action" } ] }, "docs": "Delete an action." }, { "info": { "name": "Create a Referral Action for an existing Activity.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/referral-actions", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Create a Referral Action for an existing Activity." }, { "info": { "name": "Create a Referral Action for an existing Activity.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:actionGroupId/referral-actions", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Create a Referral Action for an existing Activity." }, { "info": { "name": "hideTemplateUpdateCTA", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/template-update-cta", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "getActionTeaserById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-teasers/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ActionGroups", "type": "folder" }, "items": [ { "info": { "name": "Create an action.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id/re-order-actions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Accepts an ordered list of action ids" }, { "info": { "name": "Retrieve an individual action group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "hasActivated", "value": "", "type": "query", "description": "Whether to return already activated actions in the action group." }, { "name": "simple", "value": "", "type": "query", "description": "If true, then do not include associated data." } ] }, "docs": "Retrieve an individual action group." }, { "info": { "name": "Update an action group.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Update an action group." }, { "info": { "name": "Delete an action group.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/action-groups/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete an action group." }, { "info": { "name": "Unarchive/Restore an action group", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:id/unarchive", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Unarchive/Restore an action group" }, { "info": { "name": "Retrieve all action groups.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups", "params": [ { "name": "q", "value": "", "type": "query", "description": "Search for action group title." }, { "name": "status", "value": "", "type": "query", "description": "CSV of desired statuses (e.g. status=LIVE,PAUSED)" }, { "name": "sortable", "value": "", "type": "query", "description": "Whether an action group is available to be sorted." }, { "name": "campaignId", "value": "", "type": "query", "description": "Campaign Id" }, { "name": "audienceId", "value": "", "type": "query", "description": "Audience Id" }, { "name": "communityId", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "hasActivated", "value": "", "type": "query", "description": "Whether to return already activated actions in the action group." }, { "name": "eligibleToAddInfluencers", "value": "", "type": "query", "description": "Whether to return only action groups that have an application." }, { "name": "actionsNotIncluded", "value": "", "type": "query", "description": "Whether to return action groups without actions included." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "channel", "value": "", "type": "query", "description": "Allows the client to indicate their channel, in order to filter irrelevant resources." }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "includeExportData", "value": "", "type": "query", "description": "Whether to return action groups with the incentives summary and all affiliate data included. Used for the export." }, { "name": "ids", "value": "", "type": "query", "description": "A comma-separated list of action group ids." }, { "name": "simple", "value": "", "type": "query", "description": "If set to true, this will only return action group attributes. Only usable by administrators and other mvk services." }, { "name": "communityIds", "value": "", "type": "query" } ] }, "docs": "Retrieve all action groups." }, { "info": { "name": "Create an action group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups" }, "docs": "Create an action group." }, { "info": { "name": "getActionGroupCandidateConversations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:actionGroupId/candidates/:globalUserId/conversations", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "markedAsUnread", "value": "", "type": "query" } ] } }, { "info": { "name": "Update subscriber settings for a campaign for an authenticated account.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/account/action-groups/:id/subscriber-settings", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update subscriber settings for a campaign for an authenticated account." }, { "info": { "name": "Send a message to specified action group candidates.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/bulk-message", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Send a message to specified action group candidates." }, { "info": { "name": "Send a message to specified List Member.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/list-members/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Send a message to specified List Member." }, { "info": { "name": "If necessary, return campaign setup alert to marketer.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:id/setup-alerts", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "alert", "value": "", "type": "query" } ] }, "docs": "If necessary, return campaign setup alert to marketer." }, { "info": { "name": "Retrieve a summary of list member counts through the workflow stages.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:id/workflow-status-summary", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Retrieve a summary of list member counts through the workflow stages." }, { "info": { "name": "getSubscriberSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:id/subscriber-settings", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "copyActionGroup", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:id/copies", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getActionGroupTeaserById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-group-teaser/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "assignIncentiveToActionGroup", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/incentives/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "unassignIncentiveFromActionGroup", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/incentives/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Tracking Link", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a tracking link for an action.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action/:id/link", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of the action." }, { "name": "photo", "value": "", "type": "query", "description": "A link to user's photo" }, { "name": "referrer", "value": "", "type": "query", "description": "Referrer" }, { "name": "^utm_.+$", "value": "", "type": "query", "description": "Utm variables" } ] }, "docs": "Retrieve a tracking link for an action." } ] }, { "info": { "name": "Application", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an individual application.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:id/application", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Retrieve an individual application." }, { "info": { "name": "Update an application for an action group.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id/application", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Update an application for an action group." }, { "info": { "name": "Create a submission for an application.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:id/submissions", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Create a submission for an application." }, { "info": { "name": "getApplicationFlow", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/application-flow", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Candidates", "type": "folder" }, "items": [ { "info": { "name": "Create an assessment for an influencer.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:id/candidates/:globalUserId/assessment", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Create an assessment for an influencer." }, { "info": { "name": "Update an assessment for an influencer.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id/candidates/:globalUserId/assessment", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Update an assessment for an influencer." }, { "info": { "name": "Delete an assessment for an influencer.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/action-groups/:id/candidates/:globalUserId/assessment", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "globalUserId", "value": "", "type": "path" }, { "name": "assessorEmail", "value": "", "type": "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." }, { "name": "assessorName", "value": "", "type": "query", "description": "Name of the assessor whose assessment should be deleted." } ] }, "docs": "Delete an assessment for an influencer." }, { "info": { "name": "Retrieve all action group candidates.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:id/candidates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" }, { "name": "options", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "userFilter", "value": "", "type": "query", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition." }, { "name": "q", "value": "", "type": "query", "description": "Search parameter." }, { "name": "statusId", "value": "", "type": "query" }, { "name": "customStatusId", "value": "", "type": "query" }, { "name": "customInfluencerStatusId", "value": "", "type": "query" }, { "name": "dueDate", "value": "", "type": "query" }, { "name": "completed", "value": "", "type": "query" }, { "name": "optedIn", "value": "", "type": "query" }, { "name": "participating", "value": "", "type": "query" }, { "name": "includeInstagramPosts", "value": "", "type": "query" }, { "name": "includeViewed", "value": "", "type": "query" }, { "name": "includeCommentsCount", "value": "", "type": "query" }, { "name": "includeDraftComments", "value": "", "type": "query" }, { "name": "assessorEmail", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" } ] }, "docs": "Retrieve all action group candidates." }, { "info": { "name": "Update the status of candidates.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id/candidates", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of action group" } ] }, "docs": "Update the status of candidates." }, { "info": { "name": "Retrieve a candidate of an action group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:actionGroupId/candidates/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path", "description": "ID of action group" }, { "name": "globalUserId", "value": "", "type": "path", "description": "ID of the global user" } ] }, "docs": "Retrieve a candidate of an action group." }, { "info": { "name": "Opt-in candidates in bulk.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/bulk-opt-in", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Opt-in candidates in bulk." }, { "info": { "name": "Confirm participation/non-participation in an action group.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/confirm-participation", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Confirm participation/non-participation in an action group." } ] }, { "info": { "name": "Incentives", "type": "folder" }, "items": [ { "info": { "name": "Fetch all of the claims for this incentive.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incentives/:incentiveId/incentive-claims", "params": [ { "name": "incentiveId", "value": "", "type": "path" }, { "name": "excludeWinningClaims", "value": "", "type": "query", "description": "If the IncentiveClaim has an associated IncentiveWin, then it will not appear in the result set." }, { "name": "excludeWinningInfluencerClaims", "value": "", "type": "query", "description": "If an Influencer has an IncentiveWin, then none of their IncentiveClaims will appear in the result set." }, { "name": "uniqueInfluencers", "value": "", "type": "query", "description": "Only show one claim per influencer in the result set" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." } ] }, "docs": "Fetch all of the claims for this incentive." }, { "info": { "name": "Fetch the winners for this incentive.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/incentives/:incentiveId/winners", "params": [ { "name": "incentiveId", "value": "", "type": "path" }, { "name": "disqualified", "value": "", "type": "query", "description": "Filter winners based on whether they have been disqualified from this incentive or not." } ] }, "docs": "Fetch the winners for this incentive." }, { "info": { "name": "If the incentive is of a type where there are fewer winners than claims, this will determine the winners.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/incentives/:incentiveId/winners", "params": [ { "name": "incentiveId", "value": "", "type": "path" } ] }, "docs": "If the incentive is of a type where there are fewer winners than claims, this will determine the winners." }, { "info": { "name": "Disqualify an incentive winner.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/incentives/:incentiveId/winners/:id/disqualification", "params": [ { "name": "incentiveId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Disqualify an incentive winner." }, { "info": { "name": "Requalify a disqualified incentive winner.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/incentives/:incentiveId/winners/:id/requalification", "params": [ { "name": "incentiveId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Requalify a disqualified incentive winner." }, { "info": { "name": "getTermsAndConditionsTemplate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/termsandconditions/template", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "unlockType", "value": "", "type": "query" } ] } }, { "info": { "name": "unlockIncentive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/incentives/:id/unlock", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getAll", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/incentives" } }, { "info": { "name": "createIncentive", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/incentives" } }, { "info": { "name": "getById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/incentives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateIncentive", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/incentives/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "RewardWins", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all reward wins for an influencer.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/influencers/:influencerId/reward-wins", "params": [ { "name": "influencerId", "value": "", "type": "path" }, { "name": "isFulfilled", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "Retrieve all reward wins for an influencer." }, { "info": { "name": "bulkFulfillRewardWinsObjects", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/fulfill-objects/bulk" } }, { "info": { "name": "bulkFulfillRewardWinsObjectsWithParams", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/fulfill-objects-with-params/bulk" } }, { "info": { "name": "bulkUnfulfillRewardWinsObjects", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/unfulfill-objects/bulk" } }, { "info": { "name": "bulkUpdateRewardWinsObjects", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/update-objects/bulk" } }, { "info": { "name": "bulkUnarchiveRewardWinsObjects", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/unarchive-objects/bulk" } }, { "info": { "name": "bulkUpdateRewardWinsFilterValue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/update-filter/bulk" } }, { "info": { "name": "bulkUnarchiveRewardWinsFilterValue", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/unarchive-filter/bulk" } }, { "info": { "name": "getAllRewardWins", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reward-wins", "params": [ { "name": "fulfillmentStatus", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "userFilterData", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "excludedRewardWinIds", "value": "", "type": "query" }, { "name": "includedRewardWinIds", "value": "", "type": "query" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "daysReady", "value": "", "type": "query" }, { "name": "globalUserIds", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderField", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "includeListMember", "value": "", "type": "query" } ] } }, { "info": { "name": "updateRewardWin", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "fulfillRewardWin", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/:id/fulfillment", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "unfulfillRewardWin", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/:id/unfulfillment", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "reverseRewardWin", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/:id/reversal", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "voidTipaltiPayment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/reward-wins/:id/void-payment", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "unarchiveRewardWin", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/reward-wins/:id/unarchival", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reward-wins/dashboard/summary", "params": [ { "name": "fulfillmentStatus", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "userFilterData", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "excludedRewardWinIds", "value": "", "type": "query" }, { "name": "includedRewardWinIds", "value": "", "type": "query" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "daysReady", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderField", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Influencers", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a list of influencers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/influencers", "params": [ { "name": "q", "value": "", "type": "query", "description": "Search for influencer by first name, last name, and email." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "Retrieve a list of influencers." } ] }, { "info": { "name": "Notifications", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all scheduled notifications in a list format.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/scheduled-notifications", "params": [ { "name": "notificationDefinitionKeys", "value": "", "type": "query", "description": "Select only scheduled notifications associated with these specified notification definition keys." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "sent", "value": "", "type": "query" }, { "name": "beforeSendTime", "value": "", "type": "query", "description": "Select only notifications scheduled to be sent prior to this date-time." } ] }, "docs": "Retrieve all scheduled notifications in a list format." }, { "info": { "name": "Create a scheduled notification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/scheduled-notifications" }, "docs": "Create a scheduled notification" }, { "info": { "name": "Retrieve a single scheduled notification.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/scheduled-notifications/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single scheduled notification." }, { "info": { "name": "Update a scheduled notification. Notifications that have already been sent cannot be updated.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/scheduled-notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of scheduled notification" } ] }, "docs": "Update a scheduled notification. Notifications that have already been sent cannot be updated." }, { "info": { "name": "Delete the specified scheduled notification. Notifications that have already been sent cannot be deleted.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/scheduled-notifications/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of scheduled notification" } ] }, "docs": "Delete the specified scheduled notification. Notifications that have already been sent cannot be deleted." }, { "info": { "name": "Approve a scheduled notification to be sent.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/scheduled-notifications/:id/approval", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of scheduled notification" } ] }, "docs": "Approve a scheduled notification to be sent." }, { "info": { "name": "Unapprove a scheduled notification to not be sent.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/scheduled-notifications/:id/unapproval", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of scheduled notification" } ] }, "docs": "Unapprove a scheduled notification to not be sent." } ] }, { "info": { "name": "ActivityHistory", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a history.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:actionGroupId/activity-history/:globalUserId", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "actionGroupId", "value": "", "type": "path", "description": "The id of the activity to filter the result set by." }, { "name": "globalUserId", "value": "", "type": "path", "description": "The id of the influencer to filter the result set by." }, { "name": "eventTypes", "value": "", "type": "query", "description": "A comma-separated list of event types to return. If not specified, then return default event types." }, { "name": "conversationId", "value": "", "type": "query", "description": "A conversation's unique identifier." } ] }, "docs": "Retrieve a history." } ] }, { "info": { "name": "Authentication", "type": "folder" }, "items": [ { "info": { "name": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api-key/facebook", "params": [ { "name": "^mdp_.+$", "value": "", "type": "query", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ] }, "docs": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Pass encrypted user key in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/auto-login" }, "docs": "Pass encrypted user key in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/connected-account/instagram-business" }, "docs": "Pass Facebook access grant information in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Pass an email and check if it needs verification or existing login credentials submitted in order to proceed", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-auth/lookup", "params": [ { "name": "^mdp_.+$", "value": "", "type": "query", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ] }, "docs": "Pass an email and check if it needs verification or existing login credentials submitted in order to proceed" }, { "info": { "name": "Pass an email verification request key and new password in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-auth/signup" }, "docs": "Pass an email verification request key and new password in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Pass an email and password in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-auth/login", "params": [ { "name": "^mdp_.+$", "value": "", "type": "query", "description": "Pass in data points on sign-up, in the format mdp_{data_point_definition_key}" } ] }, "docs": "Pass an email and password in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Initiate a forgot password password request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-auth/forgot-password" }, "docs": "Initiate a forgot password password request" }, { "info": { "name": "Pass an email reset password request key and new password in exchange for a JWT to include in the header of requests.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-auth/reset-password" }, "docs": "Pass an email reset password request key and new password in exchange for a JWT to include in the header of requests." }, { "info": { "name": "Validate an email verification request.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-verification-request/validate" }, "docs": "Validate an email verification request." }, { "info": { "name": "Create an Email Verification Request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/email-verification-request/create" }, "docs": "Create an Email Verification Request" }, { "info": { "name": "Update existing influencer login credentials.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/login-credentials/update" }, "docs": "Update existing influencer login credentials." }, { "info": { "name": "loginAdmin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/api-key/login" } }, { "info": { "name": "exchangeCodeForToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/auth/facebook/exchange-code-for-token" }, "docs": "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" }, { "info": { "name": "swapCommunity", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/api-key/swap-app" } }, { "info": { "name": "getResetKey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reset-password", "params": [ { "name": "email", "value": "", "type": "query" }, { "name": "hostname", "value": "", "type": "query" } ] } }, { "info": { "name": "resetPassword", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/reset-password" } } ] }, { "info": { "name": "BatchJobs", "type": "folder" }, "items": [ { "info": { "name": "getProgressForBatchJobsWithListId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batch-jobs/:listId/status", "params": [ { "name": "listId", "value": "", "type": "path" } ] } }, { "info": { "name": "getBatchJobsSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/batch-jobs/:communityId/summary", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "CommunityBenchmarks", "type": "folder" }, "items": [ { "info": { "name": "Retrieves benchmarks for a community", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/community-benchmarks", "params": [ { "name": "fromDate", "value": "", "type": "query" } ] }, "docs": "Retrieves benchmarks for a community" } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "Get the General Folders Unread Counts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/general-folders", "params": [ { "name": "keys", "value": "", "type": "query" } ] }, "docs": "Get the General Folders Unread Counts." }, { "info": { "name": "Get the General Folders Unread Counts.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/dynamic-campaign-folders", "params": [ { "name": "keys", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "Get the General Folders Unread Counts." }, { "info": { "name": "Retrieve a message by id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/messages/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Id of the message to retrieve." }, { "name": "includes", "value": "", "type": "query", "description": "A comma-separated list of message dimensions to return. If not specified, then return standard dimensions." } ] }, "docs": "Retrieve a message by id." }, { "info": { "name": "Send a new message.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/draft", "params": [ { "name": "replyToMessageId", "value": "", "type": "query" } ] }, "docs": "Send a new message." }, { "info": { "name": "Update the draft.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/draft/:messageId", "params": [ { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Update the draft." }, { "info": { "name": "Throw out the draft.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/draft/:messageId", "params": [ { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Throw out the draft." }, { "info": { "name": "Send a message.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/sendMessage/:messageId", "params": [ { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Send a message." }, { "info": { "name": "Reply to a message.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/messages/:messageId/reply", "params": [ { "name": "messageId", "value": "", "type": "path" } ] }, "docs": "Reply to a message." }, { "info": { "name": "Retrieve conversations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "search", "value": "", "type": "query", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "markedAsUnread", "value": "", "type": "query" } ] }, "docs": "Retrieve conversations." }, { "info": { "name": "Retrieve conversations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/find-all-conversations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "search", "value": "", "type": "query", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "markedAsUnread", "value": "", "type": "query" } ] }, "docs": "Retrieve conversations." }, { "info": { "name": "Retrieve conversations.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/count-conversations", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." }, { "name": "search", "value": "", "type": "query", "description": "Search for incentive title or influencer first name, last name, or email, using a trailing wildcard." }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "markedAsUnread", "value": "", "type": "query" } ] }, "docs": "Retrieve conversations." }, { "info": { "name": "Retrieve a conversation by id.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/conversations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "The Id of the conversation to retrieve." }, { "name": "includes", "value": "", "type": "query", "description": "A comma-separated list of conversation dimensions to return. If not specified, then return standard dimensions." } ] }, "docs": "Retrieve a conversation by id." }, { "info": { "name": "bulkMarkConversationsAsRead", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversations/bulk-action/read" } }, { "info": { "name": "bulkMarkConversationsAsUnread", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversations/bulk-action/unread" } }, { "info": { "name": "bulkArchiveConversations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversations/bulk-action/archive" } }, { "info": { "name": "bulkUnarchiveConversations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversations/bulk-action/unarchive" } }, { "info": { "name": "uploadInlineImage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/inline-images" } }, { "info": { "name": "getMessageEvents", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/messages/:messageId/events", "params": [ { "name": "messageId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "event", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Datapoints", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all datapoints restricted by community and various parameters.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/data-point-definitions", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "name", "value": "", "type": "query" }, { "name": "description", "value": "", "type": "query" }, { "name": "key", "value": "", "type": "query" }, { "name": "customSet", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "archived", "value": "", "type": "query" }, { "name": "includeActiveActionGroups", "value": "", "type": "query" }, { "name": "userFilter", "value": "", "type": "query", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition." }, { "name": "q", "value": "", "type": "query", "description": "Search parameter." }, { "name": "orderProperty", "value": "", "type": "query" } ] }, "docs": "Retrieve all datapoints restricted by community and various parameters." }, { "info": { "name": "Create or edit a datapoint definition and any custom set of responses.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/data-point-definitions" }, "docs": "Create or edit a datapoint definition and any custom set of responses." }, { "info": { "name": "Retrieve a single data point definition.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/data-point-definitions/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single data point definition." }, { "info": { "name": "Update a data point definition. Data point definitions that have been assigned cannot be updated.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/data-point-definitions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of data point definition" } ] }, "docs": "Update a data point definition. Data point definitions that have been assigned cannot be updated." }, { "info": { "name": "Delete the data point definition. Data point definitions that have been assigned cannot be deleted.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/data-point-definitions/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Id of data point definition" } ] }, "docs": "Delete the data point definition. Data point definitions that have been assigned cannot be deleted." }, { "info": { "name": "Updates a specified field to a certain value for a set of a datapoints", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/data-point-definitions/bulkUpdate" }, "docs": "Updates a specified field to a certain value for a set of a datapoints" } ] }, { "info": { "name": "DataSubjectRequest", "type": "folder" }, "items": [ { "info": { "name": "Creates or updates a data subject request", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/data-subject-request/", "params": [ { "name": "id", "value": "", "type": "query" } ] }, "docs": "Creates or updates a data subject request" } ] }, { "info": { "name": "FacebookProfiles", "type": "folder" }, "items": [ { "info": { "name": "Retrieve Facebook profiles.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/facebook-profiles" }, "docs": "Retrieve Facebook profiles." }, { "info": { "name": "Designate a Facebook profile as active.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/facebook-profiles/:facebookProfileId/active", "params": [ { "name": "facebookProfileId", "value": "", "type": "path" } ] }, "docs": "Designate a Facebook profile as active." } ] }, { "info": { "name": "FacebookProfile", "type": "folder" }, "items": [ { "info": { "name": "Updates facebook account profile picture", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/facebook-profiles/update-profile-picture" }, "docs": "Updates facebook account profile picture" } ] }, { "info": { "name": "GlobalUserLists", "type": "folder" }, "items": [ { "info": { "name": "Add candidates of an action group to a global user list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:id/candidates/global-user-lists/:globalUserListId/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the action group that influencers are candidates of." }, { "name": "globalUserListId", "value": "", "type": "path" } ] }, "docs": "Add candidates of an action group to a global user list." }, { "info": { "name": "Move candidates of an action group from one global user list to another.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:id/candidates/global-user-lists/:globalUserListId/members", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the action group that influencers are candidates of." }, { "name": "globalUserListId", "value": "", "type": "path" } ] }, "docs": "Move candidates of an action group from one global user list to another." }, { "info": { "name": "Remove candidates of an action group from global user lists.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:id/candidates/global-user-lists/members/remove", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the action group that influencers are candidates of." } ] }, "docs": "Remove candidates of an action group from global user lists." }, { "info": { "name": "Retrieve global user lists.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-user-lists", "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "label", "value": "", "type": "query" }, { "name": "isArchived", "value": "", "type": "query" } ] }, "docs": "Retrieve global user lists." }, { "info": { "name": "Create a global user list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/global-user-lists" }, "docs": "Create a global user list." }, { "info": { "name": "Retrieve a single global user list.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-user-lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Retrieve a single global user list." }, { "info": { "name": "Update a global user list.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/global-user-lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update a global user list." }, { "info": { "name": "Delete a global user list.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/global-user-lists/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a global user list." }, { "info": { "name": "Archive a global user list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/global-user-lists/:id/archive", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Archive a global user list." }, { "info": { "name": "Unarchive a global user list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/global-user-lists/:id/unarchive", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Unarchive a global user list." }, { "info": { "name": "Add members to a global user list.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/global-user-lists/:globalUserListId/members", "params": [ { "name": "globalUserListId", "value": "", "type": "path" } ] }, "docs": "Add members to a global user list." }, { "info": { "name": "Move members from one global user list to another.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/global-user-lists/:globalUserListId/members", "params": [ { "name": "globalUserListId", "value": "", "type": "path" } ] }, "docs": "Move members from one global user list to another." }, { "info": { "name": "Remove members from global user lists.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/global-user-lists/members-remove" }, "docs": "Remove members from global user lists." } ] }, { "info": { "name": "GlobalUsers", "type": "folder" }, "items": [ { "info": { "name": "Retrieve all lists associated with this global user.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-user/:globalUserId/lists", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "isArchived", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" } ] }, "docs": "Retrieve all lists associated with this global user." }, { "info": { "name": "Retrieve summary of global users.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-users/summary", "params": [ { "name": "userFilter", "value": "", "type": "query", "description": "Allows for complex filtering of global users using the jsurl library to stringify instances matching the UserSearch definition." }, { "name": "q", "value": "", "type": "query", "description": "Search parameter." }, { "name": "searchKeywords", "value": "", "type": "query", "description": "Search keyword chips to specify search intent. JSON-stringified array of strings." } ] }, "docs": "Retrieve summary of global users." } ] }, { "info": { "name": "InfluencerContractCampaignTemplates", "type": "folder" }, "items": [ { "info": { "name": "Get influencer contract template for this action group, referred to as a campaign client-side.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/action-groups/:campaignId/influencer-contract-templates", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Get influencer contract template for this action group, referred to as a campaign client-side." }, { "info": { "name": "Create an influencer contract template for this campaign.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:campaignId/influencer-contract-templates", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] }, "docs": "Create an influencer contract template for this campaign." }, { "info": { "name": "Generate a contract for this campaign, and update this campaign's template if necessary.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/action-groups/:campaignId/influencer-contract-templates/:id", "params": [ { "name": "campaignId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Generate a contract for this campaign, and update this campaign's template if necessary." } ] }, { "info": { "name": "InfluencerContractCommunityTemplates", "type": "folder" }, "items": [ { "info": { "name": "Get influencer contract template for this community.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/influencer-contract-templates" }, "docs": "Get influencer contract template for this community." }, { "info": { "name": "Update this community's influencer contract template", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/influencer-contract-templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update this community's influencer contract template" } ] }, { "info": { "name": "GlobalUserAudience", "type": "folder" }, "items": [ { "info": { "name": "Retrieve possible cities to search for", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/audience-city-options", "params": [ { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "city", "value": "", "type": "query" } ] }, "docs": "Retrieve possible cities to search for" }, { "info": { "name": "Retrieve cities of the user's audience.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/global-users/:globalUserId/audience-cities", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query", "description": "Maximum number of items to return" }, { "name": "offset", "value": "", "type": "query", "description": "Number of items to skip" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." } ] }, "docs": "Retrieve cities of the user's audience." } ] }, { "info": { "name": "ActionGroupCustomStatuses", "type": "folder" }, "items": [ { "info": { "name": "Assign an action group custom status to candidates in bulk.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/bulk-assign-custom-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Assign an action group custom status to candidates in bulk." }, { "info": { "name": "getTrackingStatuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "all", "value": "", "type": "query" } ] } }, { "info": { "name": "createTrackingStatus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "reorderTrackingStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-statuses/:id/reorder", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateTrackingStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-statuses/:id", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteTrackingStatus", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/custom-statuses/:id/delete", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ActionGroupCustomInfluencerStatuses", "type": "folder" }, "items": [ { "info": { "name": "Assign an action group custom influencer status to candidates in bulk.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/bulk-assign-custom-influencer-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Assign an action group custom influencer status to candidates in bulk." }, { "info": { "name": "Assign an action group custom influencer status to a candidate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/action-groups/:actionGroupId/assign-custom-influencer-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Assign an action group custom influencer status to a candidate" }, { "info": { "name": "getInfluencerStatuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-influencer-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "createInfluencerStatus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-influencer-statuses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateInfluencerStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-influencer-statuses/:id", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteInfluencerStatus", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/custom-influencer-statuses/:id", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ListMember", "type": "folder" }, "items": [ { "info": { "name": "Retrieve an action group's list members.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/list-members/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "participating", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Attribute to order by." }, { "name": "orderDirection", "value": "", "type": "query", "description": "Select the direction by which the data will be ordered, ascending or descending." } ] }, "docs": "Retrieve an action group's list members." }, { "info": { "name": "Update multiple list members.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/list-members/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Update multiple list members." }, { "info": { "name": "Retrieve a list member.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/list-members/:actionGroupId/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path", "description": "ID of action group" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Retrieve a list member." }, { "info": { "name": "Update a list member.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/list-members/:actionGroupId/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Update a list member." } ] }, { "info": { "name": "CommunityMetrics", "type": "folder" }, "items": [ { "info": { "name": "Retrieve community metrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/community-metrics" }, "docs": "Retrieve community metrics" }, { "info": { "name": "Enable a single metric", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/community-metrics/:metricId", "params": [ { "name": "metricId", "value": "", "type": "path", "description": "Metric Id" } ] }, "docs": "Enable a single metric" }, { "info": { "name": "Disable a single metric", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/community-metrics/:metricId", "params": [ { "name": "metricId", "value": "", "type": "path", "description": "Metric Id" } ] }, "docs": "Disable a single metric" } ] }, { "info": { "name": "PayPalAccount", "type": "folder" }, "items": [ { "info": { "name": "Get a PayPal account for a member.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/paypal-account/:membershipId", "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Get a PayPal account for a member." }, { "info": { "name": "Upsert a PayPal account for a member.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/paypal-account/:membershipId", "params": [ { "name": "membershipId", "value": "", "type": "path" } ] }, "docs": "Upsert a PayPal account for a member." } ] }, { "info": { "name": "ReferralProgram", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a community's referral program activity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/referral-program", "params": [ { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Retrieve a community's referral program activity" }, { "info": { "name": "Update a community's referral program incentives", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/referral-program" }, "docs": "Update a community's referral program incentives" } ] }, { "info": { "name": "Default", "type": "folder" }, "items": [ { "info": { "name": "getReferralProgramIncentiveForReferee", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/programs/:id/get-referee-incentive", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "membershipId", "value": "", "type": "query" } ] }, "docs": "Get the incentive that a referee unlocks for a given referral program" }, { "info": { "name": "Put", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/instance-user-materialized-view" } }, { "info": { "name": "getActionGroupParticipants", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/participants", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "customStatusId", "value": "", "type": "query" }, { "name": "listMemberId", "value": "", "type": "query" }, { "name": "includeCommentsCount", "value": "", "type": "query" }, { "name": "includePinnedComment", "value": "", "type": "query" }, { "name": "includeInstagramPosts", "value": "", "type": "query" }, { "name": "includeTiktokPosts", "value": "", "type": "query" }, { "name": "postCount", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" } ] } }, { "info": { "name": "Post", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/global-users/:globalUserId/activations", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "Post", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/social-account-ingestion" } }, { "info": { "name": "Patch", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/social-account-ingestion" } }, { "info": { "name": "Put", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/tiktok-activations/:tiktokMediaId", "params": [ { "name": "tiktokMediaId", "value": "", "type": "path" } ] } }, { "info": { "name": "sendgridWebhookEvents", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/sendgrid-events", "params": [ { "name": "token", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Program", "type": "folder" }, "items": [ { "info": { "name": "getReferralProgram", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/programs/referral-program" }, "docs": "Get the referral program for a given community, including the program's incentives" } ] }, { "info": { "name": "Reports", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a report", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/reports", "params": [ { "name": "reportName", "value": "", "type": "query" }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "toDate", "value": "", "type": "query" }, { "name": "campaignId", "value": "", "type": "query" }, { "name": "reportingGroupId", "value": "", "type": "query" }, { "name": "groupBy", "value": "", "type": "query" }, { "name": "communityIds", "value": "", "type": "query" }, { "name": "networks", "value": "", "type": "query" } ] }, "docs": "Retrieve a report" } ] }, { "info": { "name": "ListMemberRewardWin", "type": "folder" }, "items": [ { "info": { "name": "Gets a list member reward win.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/list-member-reward-wins/:listMemberRewardWinId", "params": [ { "name": "listMemberRewardWinId", "value": "", "type": "path", "description": "ID of list member reward win" } ] }, "docs": "Gets a list member reward win." }, { "info": { "name": "Update the List Member Reward Win.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/list-member-reward-wins/:listMemberRewardWinId", "params": [ { "name": "listMemberRewardWinId", "value": "", "type": "path" } ] }, "docs": "Update the List Member Reward Win." }, { "info": { "name": "Get all reward wins for bulk fulfillment confirmation based on option selection", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/list-member-reward-win/bulk-fulfill/options/reward-wins" }, "docs": "Get all reward wins for bulk fulfillment confirmation based on option selection" }, { "info": { "name": "Get all bulk fulfillment options for a selection of influencers, combine all offline options into one option", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/list-member-reward-win/bulk-fulfill/options" }, "docs": "Get all bulk fulfillment options for a selection of influencers, combine all offline options into one option" }, { "info": { "name": "Get all bulk fulfillment options for a selection of influencers, splitting all offline options into their own options", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/list-member-reward-win/bulk-fulfill/options-all" }, "docs": "Get all bulk fulfillment options for a selection of influencers, splitting all offline options into their own options" }, { "info": { "name": "Get enriched list member reward win data by incentive ids. Expects comma-separated string representations of an array of integers.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/list-member-reward-wins/enriched", "params": [ { "name": "rewardWinIds", "value": "", "type": "query" }, { "name": "cashPaymentIds", "value": "", "type": "query" } ] }, "docs": "Get enriched list member reward win data by incentive ids. Expects comma-separated string representations of an array of integers." }, { "info": { "name": "getRewardWins", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/list-member-reward-wins/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" }, { "name": "includeMostRecentTransaction", "value": "", "type": "query" } ] } }, { "info": { "name": "createRewardWin", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/list-member-reward-wins/:globalUserId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Workflow", "type": "folder" }, "items": [ { "info": { "name": "Retrieve performance forecast for an action group.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflow/:actionGroupId/workflow-performance-forecast", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] }, "docs": "Retrieve performance forecast for an action group." }, { "info": { "name": "Promote global userIds to list members and set their status to the initial workflow stage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/workflow/promote-initial" }, "docs": "Promote global userIds to list members and set their status to the initial workflow stage" }, { "info": { "name": "Promote a List Member to their next status.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflow/:listMemberId/promote", "params": [ { "name": "listMemberId", "value": "", "type": "path" } ] }, "docs": "Promote a List Member to their next status." }, { "info": { "name": "Get intial workflow status with automation rules", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflow/:activityId/get-initial-status-automation-rules", "params": [ { "name": "activityId", "value": "", "type": "path" }, { "name": "expectedNumberOfInfluencers", "value": "", "type": "query" } ] }, "docs": "Get intial workflow status with automation rules" }, { "info": { "name": "Promote many List Members to their next status.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflow/bulk-promote" }, "docs": "Promote many List Members to their next status." }, { "info": { "name": "Drop a List Member.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflow/:listMemberId/drop", "params": [ { "name": "listMemberId", "value": "", "type": "path" } ] }, "docs": "Drop a List Member." }, { "info": { "name": "Drop many List Members.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/workflow/bulk-drop" }, "docs": "Drop many List Members." }, { "info": { "name": "Retrieve workflow status summary.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/workflow/:id/status-summary", "params": [ { "name": "id", "value": "", "type": "path", "description": "ID of Worklfow/List" } ] }, "docs": "Retrieve workflow status summary." } ] }, { "info": { "name": "GlobalUser", "type": "folder" }, "items": [ { "info": { "name": "retrieveCurrentUser", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/me" } }, { "info": { "name": "get", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "index", "value": "", "type": "query" }, { "name": "isPublic", "value": "", "type": "query" } ] } }, { "info": { "name": "updateGlobalUserSummary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/global-users/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update an Influencer Index creator's contact info." }, { "info": { "name": "getGlobalUsers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "useSearchWithOpenAI", "value": "", "type": "query" }, { "name": "retrieveIds", "value": "", "type": "query" }, { "name": "globalUserIds", "value": "", "type": "query" }, { "name": "prompt", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "addNewInfluencer", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/global-users" }, "docs": "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." }, { "info": { "name": "previewAddCreator", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/global-users/preview" }, "docs": "Preview CDS-first creator lookup without side effects.\nReturns what action would be taken if the creator were to be added." }, { "info": { "name": "refreshAudienceDemographics", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/audience-demographics/latest", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "getAudienceDemographics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/:globalUserId/audience-demographics", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "markPublic", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/public-users", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "markPrivate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/global-users/:globalUserId/public-users", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "enqueueCreatorRefresh", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/creator-refresh", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "makeBrandSafetyRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/brand-safety-request", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "getBrandSuitabilityReport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/:globalUserId/brand-suitability", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "query" }, { "name": "brandName", "value": "", "type": "query" } ] } }, { "info": { "name": "generateBrandSuitabilityReport", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/brand-suitability", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "getAllSocialProfiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/all-social-profiles" } }, { "info": { "name": "getInconsistencies", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/inconsistencies" } }, { "info": { "name": "repair", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/repair" } }, { "info": { "name": "getRandomGlobalUsers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/random/guids", "params": [ { "name": "limit", "value": "", "type": "query" } ] } }, { "info": { "name": "markAsNonContactable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/mark-as-non-contactable", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "deletePublicSummaryRecord", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/delete-public-summary-record", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "getGlobalUserAudienceCountries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/:globalUserId/audience-countries", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] } }, { "info": { "name": "importInfluencers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/import-influencers" } }, { "info": { "name": "fetchContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/content", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "socialNetwork", "value": "", "type": "query" }, { "name": "discover", "value": "", "type": "query" } ] } }, { "info": { "name": "reindexUser", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/reindex", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "bulkActions", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/bulk-actions" } }, { "info": { "name": "getQueryTotal", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users-total" } } ] }, { "info": { "name": "UserAccount", "type": "folder" }, "items": [ { "info": { "name": "getCurrentAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/my-account" } }, { "info": { "name": "updateCurrentAccount", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/my-account" } }, { "info": { "name": "createUserAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/user-account" } }, { "info": { "name": "getInfluencerSocialAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/social-accounts", "params": [ { "name": "globalUserId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ActivationTags", "type": "folder" }, "items": [ { "info": { "name": "getTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/activation-tags", "params": [ { "name": "query", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "createTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/activation-tags" } }, { "info": { "name": "deleteTag", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/activation-tags/:name", "params": [ { "name": "name", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Exports", "type": "folder" }, "items": [ { "info": { "name": "startAsync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/export/start-async" } }, { "info": { "name": "exportActivationContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/export/activations-content" } }, { "info": { "name": "exportContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/export/content" } }, { "info": { "name": "downloadExportContent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/export/download", "params": [ { "name": "token", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "CampaignPerformance", "type": "folder" }, "items": [ { "info": { "name": "getAudienceInsights", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaign-performance/audience-insights", "params": [ { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" } ] } }, { "info": { "name": "getAggregatedAudienceInsights", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaign-performance/audience-insights/aggregate", "params": [ { "name": "communityId", "value": "", "type": "query" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" }, { "name": "actionGroupIds", "value": "", "type": "query" } ] }, "docs": "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)." }, { "info": { "name": "getPostMetrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaign-performance/post-metrics", "params": [ { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" } ] } }, { "info": { "name": "getInfluencersMetrics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaign-performance/influencers-metrics", "params": [ { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" } ] } }, { "info": { "name": "getInfluencersConversions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaign-performance/influencers-conversions", "params": [ { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Drafts", "type": "folder" }, "items": [ { "info": { "name": "createDraftContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/draft-content" } }, { "info": { "name": "updateDraftContent", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/draft-content/:draftContentId", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveDraftContent", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/draft-content/:draftContentId", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateDraftContentStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/status", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "getDraftContentFeedback", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/feedback", "params": [ { "name": "draftContentId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "updateDraftContentFeedback", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/feedback", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "createDraftContentComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/comments", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateDraftContentComment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/comments/:id", "params": [ { "name": "draftContentId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveDraftContentFeedback", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/feedback/:id", "params": [ { "name": "draftContentId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getDraftContent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencer-draft-content/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "createDraftContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/influencer-draft-content/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "getDraftContentForListMember", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/list-member/:listMemberId/draft-content", "params": [ { "name": "listMemberId", "value": "", "type": "path" }, { "name": "viewedByEmail", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Influencer Polling", "type": "folder" }, "items": [ { "info": { "name": "addInfluencerPollingMessages", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/influencer-polling" } } ] }, { "info": { "name": "ReviewFormResponses", "type": "folder" }, "items": [ { "info": { "name": "getReviewFormResponses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/review-form-responses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "ratingsFilter", "value": "", "type": "query" }, { "name": "reviewCharacterCountFilter", "value": "", "type": "query" }, { "name": "products", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" } ] } }, { "info": { "name": "getInstanceLevelReviews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/review-form-responses", "params": [ { "name": "ratingsFilter", "value": "", "type": "query" }, { "name": "reviewCharacterCountFilter", "value": "", "type": "query" }, { "name": "products", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "LaterInfluencer", "type": "folder" }, "items": [ { "info": { "name": "getCampaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "communityIds", "value": "", "type": "query" } ] } }, { "info": { "name": "getCampaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getYtbcCampaignCode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/ytbc-campaign-code", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateCampaignMembership", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/members", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "declineCampaignInvitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/decline-invitation", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getDrafts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/drafts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "threadId", "value": "", "type": "query" } ] } }, { "info": { "name": "submitDraft", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/drafts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteDraft", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/drafts/:draftId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "draftId", "value": "", "type": "path" } ] } }, { "info": { "name": "getConcepts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/concepts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "threadId", "value": "", "type": "query" } ] } }, { "info": { "name": "submitConcept", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/concepts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteConcept", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/concepts/:conceptId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "conceptId", "value": "", "type": "path" } ] } }, { "info": { "name": "getApplicationAnswers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/application-answers", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "setApplicationAnswers", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/application-answers", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "upsertPaymentRecipient", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/payment-recipient", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "createFileUploadPolicy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/file-upload-policies", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getURLMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/url-metadata", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "url", "value": "", "type": "query" }, { "name": "s3Upload", "value": "", "type": "query" }, { "name": "s3Directory", "value": "", "type": "query" } ] } }, { "info": { "name": "getNetworks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/networks", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "submitContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/content", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getContentPreview", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/content-preview", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getReviewableProducts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/products", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "searchTerm", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] } }, { "info": { "name": "authenticateEmail", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/auth/email", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "authenticateFacebook", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/auth/facebook", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "registerTikTokCreator", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/oauth/tiktok", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "getTikTokInviteLink", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/tiktok-invite-links", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "createTikTokInviteLink", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/tiktok-invite-links", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getProductReviews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/products/:productId/reviews", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "productId", "value": "", "type": "path" } ] } }, { "info": { "name": "submitProductReview", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/products/:productId/reviews", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" }, { "name": "productId", "value": "", "type": "path" } ] } }, { "info": { "name": "getSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/settings", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateSettings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/settings", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "exportData", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "isExport", "value": "", "type": "query" } ] } }, { "info": { "name": "getStripeOnboardingLink", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/payment-providers/stripe/onboarding-link", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "redirectUrl", "value": "", "type": "query" } ] } }, { "info": { "name": "getStripeDashboardLink", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/payment-providers/stripe/dashboard-link", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "getStripeAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/payment-providers/stripe/accounts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteStripeConnectedAccount", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/payment-providers/stripe/accounts", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "getBrands", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/brands", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" } ] } }, { "info": { "name": "getInfluencerStatuses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/influencer-statuses", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "setInfluencerStatus", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/influencer-status-reports", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getExternalPlatformConnections", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/connections", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "connectExternalPlatform", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/connections", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getLinks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:campaignId/links", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "getSurvey", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/surveys/:surveyId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "surveyId", "value": "", "type": "path" } ] } }, { "info": { "name": "submitSurveyAnswers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/surveys/:surveyId/answers", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "surveyId", "value": "", "type": "path" } ] } }, { "info": { "name": "getInfluencerPostPartnershipRequests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:actionGroupId/post-partnership-requests", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateInfluencerPostPartnershipRequest", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:actionGroupId/post-partnership-requests/:requestId", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "requestId", "value": "", "type": "path" } ] } }, { "info": { "name": "getInfluenerPostPartnershipSponsor", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/later-influencers/:influencerIdOrCreatorId/campaigns/:actionGroupId/post-partnership-sponsor", "params": [ { "name": "influencerIdOrCreatorId", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ActionGroupConversationTemplates", "type": "folder" }, "items": [ { "info": { "name": "getActionGroupConversationTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "createActionGroupConversationTemplate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "resetActionGroupConversationTemplates", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "copyActionGroupConversationTemplate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates/:id/copy", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateActionGroupConversationTemplate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates/:id", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteActionGroupConversationTemplate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates/:id", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "reorderActionGroupConversationTemplates", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/conversation-templates/reorder", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ReviewForm", "type": "folder" }, "items": [ { "info": { "name": "upsertReviewForm", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/review-forms", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Reviews", "type": "folder" }, "items": [ { "info": { "name": "getReviewFormByActionId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action/:id/review-form", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ActionGroupBrief", "type": "folder" }, "items": [ { "info": { "name": "postNewVersion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:id/updateBrief", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ActionGroupsStatus", "type": "folder" }, "items": [ { "info": { "name": "getActionGroupStatuses", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/statuses" } } ] }, { "info": { "name": "ActivationTagsAssociations", "type": "folder" }, "items": [ { "info": { "name": "associateTagsToActivations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/activation-tags-associations" } }, { "info": { "name": "disassociateTagsFromActivations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/activation-tags-associations", "params": [ { "name": "activationIds", "value": "", "type": "query" }, { "name": "tagIds", "value": "", "type": "query" } ] } }, { "info": { "name": "getTagsByActivationId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/activation-tags-associations/:activationId", "params": [ { "name": "activationId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "GetInfluencerIncentiveCosts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/influencer-incentive-info", "params": [ { "name": "rewardWinIds", "value": "", "type": "query" }, { "name": "listMemberIds", "value": "", "type": "query" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "globalUserId", "value": "", "type": "query" } ] } }, { "info": { "name": "GetEnrichCampaignsData", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/campaign-details", "params": [ { "name": "campaignId", "value": "", "type": "query" } ] } }, { "info": { "name": "GetCreatorsEnrichment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/creators-enrichment", "params": [ { "name": "globalUserId", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" } ] } }, { "info": { "name": "GetCreatorDetails", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/v2/creators-enrichment", "params": [ { "name": "globalUserId", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" } ] } }, { "info": { "name": "getCreatorDetailsMultiCommunity", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/v3/creators-enrichment", "params": [ { "name": "globalUserIds", "value": "", "type": "query" } ] } }, { "info": { "name": "GetContentEnrichment", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/content-enrichment", "params": [ { "name": "activationId", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" }, { "name": "includeAdditionalCreatorProfileInfo", "value": "", "type": "query" } ] } }, { "info": { "name": "GetContentEnrichmentV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/v2/content-enrichment", "params": [ { "name": "activationIds", "value": "", "type": "query" }, { "name": "includeAdditionalCreatorProfileInfo", "value": "", "type": "query" } ] } }, { "info": { "name": "backfillAnalyticsServiceData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/reporting-details/backfill" } }, { "info": { "name": "backfillAnalyticsServiceData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/reporting-details/backfill-cost" } }, { "info": { "name": "GetCampaignReviews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/reporting-details/reviews", "params": [ { "name": "campaignId", "value": "", "type": "query" }, { "name": "groupBy", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Backfill Analytics", "type": "folder" }, "items": [ { "info": { "name": "backfillFollowersAtPost", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/backfill-analytics/followers-at-post" } }, { "info": { "name": "updateContentActivationSummary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/backfill-analytics/update-content-activation-summary" } } ] }, { "info": { "name": "PendingBatchJobs", "type": "folder" }, "items": [ { "info": { "name": "getPendingBatchJobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/pending-batch-jobs/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "BulkAssignCustomStatusesRequirements", "type": "folder" }, "items": [ { "info": { "name": "getRequirements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/bulk-assign-custom-statuses-requirements", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "listId", "value": "", "type": "query" }, { "name": "expectedNumberOfInfluencers", "value": "", "type": "query" }, { "name": "currentCustomStatusId", "value": "", "type": "query" }, { "name": "targetCustomStatusId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "BazaarVoice", "type": "folder" }, "items": [ { "info": { "name": "getBazaarApps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/bazaar-apps" } }, { "info": { "name": "createBazaarApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/bazaar-apps" } }, { "info": { "name": "getBazaarAppLocales", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/bazaar-apps/locales" } } ] }, { "info": { "name": "Blogs", "type": "folder" }, "items": [ { "info": { "name": "getBlogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/blogs" } }, { "info": { "name": "updateBlogs", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/blogs" } }, { "info": { "name": "updateBlogForGlobalUser", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/blogs/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "BrandSuitabilityHarness", "type": "folder" }, "items": [ { "info": { "name": "harnessCreatorContext", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/creator-context", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Builds a structured creator profile from platform data (social handles, bio, location, etc.) *" }, { "info": { "name": "harnessSaveCreatorContext", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/creator-context", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Builds (or accepts inline) creator context and persists it to DynamoDB, returning the stored record. *" }, { "info": { "name": "harnessGetStoredCreatorContext", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/creator-context/stored", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Reads the stored creator context record from DynamoDB. *" }, { "info": { "name": "harnessUpdateCreatorContext", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/creator-context/stored", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Partial-updates the stored creator context fields. *" }, { "info": { "name": "harnessDeleteCreatorContext", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/creator-context/stored", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Deletes the stored creator context record. *" }, { "info": { "name": "harnessBrandContext", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/harness/brand-context", "params": [ { "name": "communityId", "value": "", "type": "query" } ] } }, { "info": { "name": "harnessSaveBrandContext", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/brand-context", "params": [ { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Builds (or accepts inline) brand context and persists it to DynamoDB, returning the stored record. *" }, { "info": { "name": "harnessGetStoredBrandContext", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/harness/brand-context/stored", "params": [ { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Reads the stored brand context record from DynamoDB. *" }, { "info": { "name": "harnessUpdateBrandContext", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/brand-suitability/harness/brand-context/stored", "params": [ { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Partial-updates the stored brand context fields. *" }, { "info": { "name": "harnessDeleteBrandContext", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/brand-suitability/harness/brand-context/stored", "params": [ { "name": "communityId", "value": "", "type": "query" } ] }, "docs": "Deletes the stored brand context record. *" }, { "info": { "name": "harnessCampaignContext", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/harness/campaigns/:campaignId/campaign-context", "params": [ { "name": "campaignId", "value": "", "type": "path" } ] } }, { "info": { "name": "harnessResearch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/research" }, "docs": "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." }, { "info": { "name": "harnessVerifySources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/verify-sources" }, "docs": "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." }, { "info": { "name": "harnessReverify", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/global-users/:globalUserId/reverify", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "harnessAssessMetric", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/assess" } }, { "info": { "name": "harnessAssessFull", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/harness/assess-full" }, "docs": "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." } ] }, { "info": { "name": "BrandSuitability", "type": "folder" }, "items": [ { "info": { "name": "getCreatorsWithReports", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users", "params": [ { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Frontend: unused for now -- TODO for admin view. *" }, { "info": { "name": "getReportById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports/:reportId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "reportId", "value": "", "type": "path" } ] }, "docs": "Frontend: Lightbox (polling during generation), Admin DetailView *" }, { "info": { "name": "deleteReport", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports/:reportId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "reportId", "value": "", "type": "path" } ] } }, { "info": { "name": "getLatestReport", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/report", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "query" } ] }, "docs": "Frontend: Lightbox reports" }, { "info": { "name": "getReportsForCreator", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "query" } ] }, "docs": "Frontend: Admin — DetailView, ReportsSelector *" }, { "info": { "name": "generateReport", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Frontend: Lightbox — generate + refresh buttons, Admin DetailView *" }, { "info": { "name": "generateReportSync", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports/sync", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Frontend: Admin — DetailView *" }, { "info": { "name": "refreshCreatorResearch", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/research/refresh", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "brandName", "value": "", "type": "query" }, { "name": "force", "value": "", "type": "query" } ] }, "docs": "Frontend: unused (async version) *" }, { "info": { "name": "refreshCreatorResearchSync", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/research/refresh/sync", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "brandName", "value": "", "type": "query" }, { "name": "force", "value": "", "type": "query" } ] }, "docs": "Frontend: Admin — DetailView, TableView *" }, { "info": { "name": "getCreatorResearch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/research", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "Frontend: Admin — DetailView *" }, { "info": { "name": "getCreatorResearchStatus", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/research/status", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateFindingExclusions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/brand-suitability/global-users/:globalUserId/reports/:reportId/findings/exclude", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "reportId", "value": "", "type": "path" } ] }, "docs": "Frontend: Lightbox — ResearchFindingsTable action bar *" }, { "info": { "name": "getReportStats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/stats" } }, { "info": { "name": "listBatches", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/batches" }, "docs": "Frontend: Bulk dashboard — list batches for the community (cached counters; no report reads). *" }, { "info": { "name": "createBatch", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/batches" }, "docs": "Frontend: Bulk dashboard — create a batch of reports for a set of creators (explicit ids or a search query). *" }, { "info": { "name": "getBatch", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/brand-suitability/batches/:batchId", "params": [ { "name": "batchId", "value": "", "type": "path" } ] }, "docs": "Frontend: Bulk dashboard — batch detail: per-creator status table + derived counts. *" }, { "info": { "name": "addBatchCreators", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/brand-suitability/batches/:batchId/creators", "params": [ { "name": "batchId", "value": "", "type": "path" } ] }, "docs": "Frontend: Bulk dashboard — add more creators to an existing batch (R4). *" } ] }, { "info": { "name": "InstanceBrands", "type": "folder" }, "items": [ { "info": { "name": "listInstanceBrands", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/instances/:instanceId/brands", "params": [ { "name": "instanceId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Budgets", "type": "folder" }, "items": [ { "info": { "name": "getActionGroupBudgets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/budgets/action-groups", "params": [ { "name": "actionGroupStatuses", "value": "", "type": "query" }, { "name": "types", "value": "", "type": "query" } ] } }, { "info": { "name": "getInfluencersBudget", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/budgets/influencers", "params": [ { "name": "actionGroupIds", "value": "", "type": "query" } ] } }, { "info": { "name": "getCommunityBudgets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/budgets/community" } }, { "info": { "name": "bulkCreateBudgets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/budgets/bulk" } }, { "info": { "name": "createBudget", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/budgets" } } ] }, { "info": { "name": "CampaignPlatformCallback", "type": "folder" }, "items": [ { "info": { "name": "receiveCampaignPlatformFulfillmentCallback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/api/content-activations" } } ] }, { "info": { "name": "Campaigns", "type": "folder" }, "items": [ { "info": { "name": "getAllCampaigns", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaigns", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" } ] } }, { "info": { "name": "createCampaign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/campaigns" } }, { "info": { "name": "getCampaignById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaigns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateCampaign", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/campaigns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Delete", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/campaigns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getActionGroupIdsForReportingGroup", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/campaigns/reporting-group/ids", "params": [ { "name": "reportingGroupIds", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "CashPayments", "type": "folder" }, "items": [ { "info": { "name": "getCashPaymentApps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cash-payment-apps", "params": [ { "name": "checkEnabledProvider", "value": "", "type": "query" } ] } }, { "info": { "name": "createCashPaymentApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/cash-payment-apps" } }, { "info": { "name": "getCashPaymentApp", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/cash-payment-apps/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateCashPaymentApp", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/cash-payment-apps/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "AnonymousComments", "type": "folder" }, "items": [ { "info": { "name": "queryAnonymousComments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/global-users/:globalUserId/anonymous-comments", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" } ] } }, { "info": { "name": "createAnonymousComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/global-users/:globalUserId/anonymous-comments", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Comments", "type": "folder" }, "items": [ { "info": { "name": "getGlobalUserComments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/global-users/:globalUserId/comments", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "createGlobalUserComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users/:globalUserId/comments", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateGlobalUserComment", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/global-users/:globalUserId/comments/:commentId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ] } }, { "info": { "name": "getNotificationComments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/notification_comments", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "resourceType", "value": "", "type": "query" }, { "name": "resourceId", "value": "", "type": "query" }, { "name": "author", "value": "", "type": "query" } ] } }, { "info": { "name": "createNotificationComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/notification_comments" } } ] }, { "info": { "name": "Community", "type": "folder" }, "items": [ { "info": { "name": "getCommunityInfoWithAffiliates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/comm-info" } }, { "info": { "name": "updateCommmunityInfo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/comm-info" } }, { "info": { "name": "getCommunityInfo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/comm/:communityId/info", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } }, { "info": { "name": "getCommunityNews", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/comm/:communityId/news", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "InstanceDeactivation", "type": "folder" }, "items": [ { "info": { "name": "deactivateInstance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/communities/:communityId/deactivate", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } }, { "info": { "name": "reactivateInstance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/communities/:communityId/reactivate", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "InstanceReactivation", "type": "folder" }, "items": [ { "info": { "name": "reactivateInstance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/community/:communityId/reactivate", "params": [ { "name": "communityId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Concepts", "type": "folder" }, "items": [ { "info": { "name": "createConceptContentComment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/comments", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateConceptContentComment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/comments/:id", "params": [ { "name": "conceptContentId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateConceptContentStatus", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/status", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "getConceptContentFeedback", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/feedback", "params": [ { "name": "conceptContentId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "updateConceptContentFeedback", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/feedback", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveConceptContentFeedback", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/feedback/:id", "params": [ { "name": "conceptContentId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "createConceptContent", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/concept-content" } }, { "info": { "name": "updateConceptContent", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveConceptContent", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "createConceptContentViewed", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/concept-content/:conceptContentId/view", "params": [ { "name": "conceptContentId", "value": "", "type": "path" } ] } }, { "info": { "name": "getConceptContentForListMember", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/list-member/:listMemberId/concept-content", "params": [ { "name": "listMemberId", "value": "", "type": "path" }, { "name": "viewedByEmail", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Content", "type": "folder" }, "items": [ { "info": { "name": "GetContent", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/content", "params": [ { "name": "activationIds", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ConversationTemplates", "type": "folder" }, "items": [ { "info": { "name": "getConversationTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/conversation-templates", "params": [ { "name": "isArchived", "value": "", "type": "query" } ] } }, { "info": { "name": "createConversationTemplate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversation-templates" } }, { "info": { "name": "getConversationTemplate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/conversation-templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateConversationTemplate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/conversation-templates/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "MergeTagsCatalog", "type": "folder" }, "items": [ { "info": { "name": "getMergeTagsCatalog", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/communities/:communityId/campaigns/:campaignId/merge-tags", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ConversionTags", "type": "folder" }, "items": [ { "info": { "name": "getAllConversionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/conversions-tags", "params": [ { "name": "name", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "createConversionTag", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversions-tags" } }, { "info": { "name": "getAllConversionTags", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/conversions-tags/:id", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "name", "value": "", "type": "query" } ] } }, { "info": { "name": "updateConversionTag", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/conversions-tags/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "CreatorSummary", "type": "folder" }, "items": [ { "info": { "name": "getCreatorSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/creator-summary/global-users/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "refreshCreatorSummary", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/creator-summary/global-users/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "research", "value": "", "type": "query" } ] }, "docs": "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)." } ] }, { "info": { "name": "Custom Analytics Admin", "type": "folder" }, "items": [ { "info": { "name": "listCustomAnalyticsConfigs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs", "params": [ { "name": "communityId", "value": "", "type": "query" }, { "name": "dashboardType", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "createCustomAnalyticsConfig", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs" } }, { "info": { "name": "getCustomAnalyticsConfigById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateCustomAnalyticsConfig", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteCustomAnalyticsConfig", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "getCustomAnalyticsConfigByCommunityAndType", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs/community/:communityId/dashboard-type/:dashboardType", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "dashboardType", "value": "", "type": "path" } ] } }, { "info": { "name": "getDefaultCustomAnalyticsConfigByType", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/custom-analytics/configs/default/dashboard-type/:dashboardType", "params": [ { "name": "dashboardType", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Custom Analytics Controller", "type": "folder" }, "items": [ { "info": { "name": "getOmniAnalyticsDashboard", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/custom-analytics/omni-analytics/embed-dashboard", "params": [ { "name": "dashboardType", "value": "", "type": "query" } ] } }, { "info": { "name": "getDashboardTypes", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/custom-analytics/dashboard-types", "params": [ { "name": "instanceId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "MembershipDataPoints", "type": "folder" }, "items": [ { "info": { "name": "getMembershipDataPoints", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/membership-data-points", "params": [ { "name": "dataPoints", "value": "", "type": "query" }, { "name": "globalUserId", "value": "", "type": "query" } ] } }, { "info": { "name": "updateDataPoint", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/membership-data-point/:membershipId/:dataPointDefinitionId", "params": [ { "name": "membershipId", "value": "", "type": "path" }, { "name": "dataPointDefinitionId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "DraftContentViewed", "type": "folder" }, "items": [ { "info": { "name": "createDraftContentViewed", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/draft-content/:draftContentId/view", "params": [ { "name": "draftContentId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "EarnedMediaValue", "type": "folder" }, "items": [ { "info": { "name": "backfillEmv", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/earned-media-value" } }, { "info": { "name": "backfillEmvForListsAndListMembers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/earned-media-value/backfill-lists-and-list-members" } } ] }, { "info": { "name": "Elasticsearch", "type": "folder" }, "items": [ { "info": { "name": "getIds", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/elasticsearch/retrieveDocuments", "params": [ { "name": "facebookProfileIds", "value": "", "type": "query" }, { "name": "instagramProfileIds", "value": "", "type": "query" }, { "name": "membershipIds", "value": "", "type": "query" } ] } }, { "info": { "name": "retrieveDocuments", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/elasticsearch/retrieveDocuments" } }, { "info": { "name": "removeMissingGlobalUsers", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/elasticsearch/removeMissingGlobalUsers" } } ] }, { "info": { "name": "ElasticsearchOptions", "type": "folder" }, "items": [ { "info": { "name": "getOptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/elasticsearch-options/options", "params": [ { "name": "field", "value": "", "type": "query" }, { "name": "userString", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Email Suppressions", "type": "folder" }, "items": [ { "info": { "name": "deleteEmailBlocklist", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/email-blocklist/:email", "params": [ { "name": "email", "value": "", "type": "path", "description": "The email address to remove from blocklists" } ] }, "docs": "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.)" } ] }, { "info": { "name": "EmailSettings", "type": "folder" }, "items": [ { "info": { "name": "getCurrentEmailSettings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/smtp-email" } }, { "info": { "name": "updateEmailSettings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/smtp-email/:fromName/:fromEmail", "params": [ { "name": "fromName", "value": "", "type": "path" }, { "name": "fromEmail", "value": "", "type": "path" } ] } }, { "info": { "name": "get", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/email-settings", "params": [ { "name": "id", "value": "", "type": "query" } ] } }, { "info": { "name": "post", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/email-settings" } } ] }, { "info": { "name": "Entitlements", "type": "folder" }, "items": [ { "info": { "name": "getEntitlements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/entitlements", "params": [ { "name": "featureIds", "value": "", "type": "query" } ] } }, { "info": { "name": "updateEntitlements", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/entitlements" } }, { "info": { "name": "bulkUpdateEntitlements", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/entitlements/bulk" }, "docs": "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" } ] }, { "info": { "name": "Features", "type": "folder" }, "items": [ { "info": { "name": "getFeatures", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/features" } }, { "info": { "name": "getFeatureById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/features/:featureId", "params": [ { "name": "featureId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateFeature", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/features/:featureId", "params": [ { "name": "featureId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "EventLogs", "type": "folder" }, "items": [ { "info": { "name": "getEventLogs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/event-logs", "params": [ { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query" }, { "name": "eventType", "value": "", "type": "query" }, { "name": "resourceType", "value": "", "type": "query" }, { "name": "resourceId", "value": "", "type": "query" }, { "name": "invokedBy", "value": "", "type": "query" } ] } }, { "info": { "name": "postEventLog", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/event-logs" } } ] }, { "info": { "name": "CampaignApplication", "type": "folder" }, "items": [ { "info": { "name": "submitCampaignApplication", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/external-campaign-application" } }, { "info": { "name": "linkMavely", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/external-campaign-application/connect-mavely", "params": [ { "name": "mavely_profile_id", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" } ] } }, { "info": { "name": "connectMavelyUrl", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/external-campaign-application/connect-mavely/url", "params": [ { "name": "global_user_id", "value": "", "type": "query" }, { "name": "action_group_id", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ExternalClients", "type": "folder" }, "items": [ { "info": { "name": "getAllExternalClients", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/external-clients", "params": [ { "name": "clientId", "value": "", "type": "query", "description": "Optional client ID to filter results" }, { "name": "page", "value": "", "type": "query", "description": "Page number (default: 1)" }, { "name": "pageSize", "value": "", "type": "query", "description": "Number of results per page (default: 20, max: 100)" } ] }, "docs": "Get all clients with their instances, or filter by clientId.\nIncludes deleted clients and separates active/inactive instances." }, { "info": { "name": "createExternalClient", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/external-clients" }, "docs": "Create a new external client" }, { "info": { "name": "regenerateExternalClientSecret", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/external-clients/:clientId/secrets", "params": [ { "name": "clientId", "value": "", "type": "path", "description": "The unique identifier for the client" } ] }, "docs": "Regenerate the client secret" }, { "info": { "name": "deleteExternalClient", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/admin/external-clients/:clientId", "params": [ { "name": "clientId", "value": "", "type": "path", "description": "The unique identifier for the client" } ] }, "docs": "Soft delete a client and all associated instances" }, { "info": { "name": "associateExternalClientInstances", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/external-clients/:clientId/instances", "params": [ { "name": "clientId", "value": "", "type": "path", "description": "The unique identifier for the client" } ] }, "docs": "Associate instances to a client" }, { "info": { "name": "deleteExternalClientInstance", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/admin/external-clients/:clientId/instances/:instanceId", "params": [ { "name": "clientId", "value": "", "type": "path", "description": "The unique identifier for the client" }, { "name": "instanceId", "value": "", "type": "path", "description": "The instance ID to remove" } ] }, "docs": "Soft delete a client instance association" } ] }, { "info": { "name": "MavelyTransfers", "type": "folder" }, "items": [ { "info": { "name": "getMavelyTransfer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/mavely/transfers/:rewardWinId", "params": [ { "name": "rewardWinId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "PaymentRecipient", "type": "folder" }, "items": [ { "info": { "name": "createPaymentRecipient", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients" } }, { "info": { "name": "sendPaymentRecipientOnboardingReminder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients/notification" } }, { "info": { "name": "getPaymentRecipient", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-recipients/:uuid", "params": [ { "name": "uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "getTipaltiPayeeIframeUrl", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-recipients/:uuid/tipalti-payees/iframe-url", "params": [ { "name": "uuid", "value": "", "type": "path" } ] } }, { "info": { "name": "requestPaymentRecipientVerification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients/verifications" } }, { "info": { "name": "confirmPaymentRecipientVerification", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients/verifications/confirm" } }, { "info": { "name": "getPaymentRecipientByListMemberId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-recipients/list-members/:listMemberId", "params": [ { "name": "listMemberId", "value": "", "type": "path" } ] } }, { "info": { "name": "clearPaymentRecipientLinks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients/links/clear" }, "docs": "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." }, { "info": { "name": "propagatePaymentRecipientLinks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-recipients/links/propagate" }, "docs": "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." } ] }, { "info": { "name": "StripePayments", "type": "folder" }, "items": [ { "info": { "name": "configureStripeProviderAppToInstances", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stripe/payment-providers/bulk-enable" } }, { "info": { "name": "createStripeConnectedAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stripe/accounts/create/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "query" } ] } }, { "info": { "name": "sendStripeOnboardingReminder", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/stripe/accounts/notification" } }, { "info": { "name": "getStripeAccountsByGlobalUserIds", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stripe/accounts/:globalUserIds", "params": [ { "name": "globalUserIds", "value": "", "type": "path" } ] } }, { "info": { "name": "getStripeAccountByGlobalUserId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stripe/accounts/account/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" } ] } }, { "info": { "name": "disconnectStripeAccountByGlobalUserId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/stripe/accounts/:globalUserId/disconnect", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "query" } ] } }, { "info": { "name": "deleteStripeAccountByGlobalUserId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/stripe/accounts/:globalUserId/delete", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "country", "value": "", "type": "query" } ] } }, { "info": { "name": "getStripeExchangeRates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/exchange-rates/stripe" } }, { "info": { "name": "getStripeTransfer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/stripe/transfers/:uniqueTransferId", "params": [ { "name": "uniqueTransferId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "TipaltiPayee", "type": "folder" }, "items": [ { "info": { "name": "getTipaltiPayeeByRefCode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tipalti-payees/:refCode", "params": [ { "name": "refCode", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "TipaltiTransfers", "type": "folder" }, "items": [ { "info": { "name": "getTipaltiTransfer", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tipalti/transfers/:rewardWinId", "params": [ { "name": "rewardWinId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "GiftCards", "type": "folder" }, "items": [ { "info": { "name": "getEmailTemplates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/gift-cards/email-templates" } }, { "info": { "name": "getGiftCardBalance", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/gift-cards/balance" } }, { "info": { "name": "getGiftCardOptions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/gift-cards/options" } } ] }, { "info": { "name": "GroupHigh", "type": "folder" }, "items": [ { "info": { "name": "getLightboxTikTokGraphs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/grouphigh/graphs/lightbox-tiktok", "params": [ { "name": "globalUserId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Images", "type": "folder" }, "items": [ { "info": { "name": "proxyImage", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/image-proxy", "params": [ { "name": "url", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "DBInfluencerAgreementHistoryFields", "type": "folder" }, "items": [ { "info": { "name": "updateIfluencerAgreementHistoryFields", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/influencer-agreement" } } ] }, { "info": { "name": "InfluencerCampaign", "type": "folder" }, "items": [ { "info": { "name": "getInfluencerCampaignHistory", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencer-campaign-history", "params": [ { "name": "membershipId", "value": "", "type": "query" }, { "name": "includeContent", "value": "", "type": "query" }, { "name": "hideOnIcm", "value": "", "type": "query" } ] } }, { "info": { "name": "getInfluencerCampaign", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencer-campaign/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "InfluencerLinks", "type": "folder" }, "items": [ { "info": { "name": "getInfluencerLinks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencer-links/:globalUserId", "params": [ { "name": "globalUserId", "value": "", "type": "path" }, { "name": "actionGroupId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "InfluencerReviewDeliverable", "type": "folder" }, "items": [ { "info": { "name": "upsertReviewDeliverable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/influencer-review-deliverable" } }, { "info": { "name": "deleteReviewDeliverable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/influencer-review-deliverable/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "InfluencerList", "type": "folder" }, "items": [ { "info": { "name": "getInfluencerPerformanceList", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencers/performance-list", "params": [ { "name": "orderBy", "value": "", "type": "query" }, { "name": "date", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "uploadPolicy", "type": "folder" }, "items": [ { "info": { "name": "uploadPolicy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/upload-policy" } } ] }, { "info": { "name": "InstagramAccount", "type": "folder" }, "items": [ { "info": { "name": "updateInstagramProfilePicture", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/instagram-profiles/update-profile-picture" } }, { "info": { "name": "activateInstagramProfile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/instagram-profiles/:instagramProfileId/active", "params": [ { "name": "instagramProfileId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Links", "type": "folder" }, "items": [ { "info": { "name": "getLinks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:id/links", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "listMemberId", "value": "", "type": "query" }, { "name": "includeDeleted", "value": "", "type": "query" }, { "name": "mavelyProfileId", "value": "", "type": "query" } ] } }, { "info": { "name": "postLinks", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:id/links", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateLinks", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:id/links/:linkId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "linkId", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveLinks", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:id/links/:linkId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "linkId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Specs", "type": "folder" }, "items": [ { "info": { "name": "getSpecs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:id/specs", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "title", "value": "", "type": "query" }, { "name": "destinationUrl", "value": "", "type": "query" }, { "name": "includeCommissions", "value": "", "type": "query" } ] } }, { "info": { "name": "postSpecs", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/action-groups/:id/specs", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateSpecs", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:id/specs/:specId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "specId", "value": "", "type": "path" } ] } }, { "info": { "name": "archiveSpec", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:id/specs/:specId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "specId", "value": "", "type": "path" } ] } }, { "info": { "name": "getBrandDetails", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:id/specs/brand-details", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "link", "value": "", "type": "query" }, { "name": "metadataIncluded", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ListDeliverables", "type": "folder" }, "items": [ { "info": { "name": "createListDeliverable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists/:listId/list-deliverables", "params": [ { "name": "listId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateListDeliverable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/lists/:listId/list-deliverables/:id", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteListDeliverable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/lists/:listId/list-deliverables/:id", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ListMemberDeliverables", "type": "folder" }, "items": [ { "info": { "name": "getListMemberDeliverables", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "listMemberId", "value": "", "type": "query" }, { "name": "contentType", "value": "", "type": "query" }, { "name": "listCustomStatusId", "value": "", "type": "query" } ] } }, { "info": { "name": "createListMemberDeliverable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables", "params": [ { "name": "listId", "value": "", "type": "path" } ] } }, { "info": { "name": "bulkAssignDeliverables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables/bulk-assign", "params": [ { "name": "listId", "value": "", "type": "path" } ] } }, { "info": { "name": "queryBulkAssignSummary", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables/bulk-assign-summary", "params": [ { "name": "listId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateListMemberDeliverable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables/:listMemberDeliverableId", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "listMemberDeliverableId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteListMemberDeliverable", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables/:listMemberDeliverableId", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "listMemberDeliverableId", "value": "", "type": "path" } ] } }, { "info": { "name": "getListMemberDeliverablesSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/list-member-deliverables/summary", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "listCustomStatusId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ActionGroupBulkScheduledMessages", "type": "folder" }, "items": [ { "info": { "name": "createBulkListMemberScheduledMessage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/bulk-messages-schedule" } } ] }, { "info": { "name": "ActionGroupScheduledMessages", "type": "folder" }, "items": [ { "info": { "name": "createListMemberScheduledMessage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/messages-scheduling" } }, { "info": { "name": "editListMemberScheduledMessage", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/messages-scheduling" } }, { "info": { "name": "replyListMemberScheduledMessage", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/messages-scheduling/schedule-reply" } }, { "info": { "name": "sendScheduledMessageNow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/messages-scheduling/send-now" } } ] }, { "info": { "name": "Lists", "type": "folder" }, "items": [ { "info": { "name": "getUserIfListMember", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/lists/:listId/users/:id", "params": [ { "name": "listId", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ListMemberMavelyProfiles", "type": "folder" }, "items": [ { "info": { "name": "findAllListMemberMavelyProfiles", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/list-member-mavely-profiles", "params": [ { "name": "mavelyProfileId", "value": "", "type": "query" }, { "name": "listMemberId", "value": "", "type": "query" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "globalUserId", "value": "", "type": "query" } ] } }, { "info": { "name": "getListMemberMavelyProfiles", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/list-members/mavely/profiles" } }, { "info": { "name": "deleteListMemberMavelyProfilesByActionGroupId", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/list-members/disconnect/mavely", "params": [ { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "globalUserId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "ListMembers", "type": "folder" }, "items": [ { "info": { "name": "getListMemberGlobalUserIds", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/list-members" } } ] }, { "info": { "name": "MarketerNotifications", "type": "folder" }, "items": [ { "info": { "name": "updateNotificationGroups", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/notification-groups" } }, { "info": { "name": "setNotificationPreferences", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/notification-preferences/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "MembershipPurchases", "type": "folder" }, "items": [ { "info": { "name": "awardPointsForPurchase", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/membership-points-for-purchase" } } ] }, { "info": { "name": "Membership", "type": "folder" }, "items": [ { "info": { "name": "getMembershipContactInfo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/membership/contact-info" } }, { "info": { "name": "updateMembershipContactInfo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/membership/contact-info" } }, { "info": { "name": "updateInfluencerContactInfo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/influencers/:id/contact-info", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Update a My Members creator contact info." }, { "info": { "name": "updateSignature", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/membership/signature" } }, { "info": { "name": "getMembershipSummary", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/membership/summary" } }, { "info": { "name": "updateMembershipProfileInfo", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/membership-profile-info" } }, { "info": { "name": "getMembership", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/membership/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "updateMembership", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/membership/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "removeMembership", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/remove-membership" } } ] }, { "info": { "name": "Meta Ad Admin", "type": "folder" }, "items": [ { "info": { "name": "GetSystemUsersAdAccountsInfo", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/admin/meta/system-users/ad-accounts" } }, { "info": { "name": "backfillAdAccountInsightsData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/meta/backfill/ad-insights" } }, { "info": { "name": "pushAdAccountInsightsData", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/meta/backfill/ad-insights/push" } }, { "info": { "name": "backfillAdInformationForAdAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/meta/backfill/ads" } }, { "info": { "name": "backfillLifetimeAdInsights", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/admin/meta/backfill/ads/lifetime-insights" } } ] }, { "info": { "name": "Meta Business Assets", "type": "folder" }, "items": [ { "info": { "name": "getBusinessAssets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/marketers/meta/business/assets" } }, { "info": { "name": "updateBusinessAsset", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/marketers/meta/business/assets/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Meta Business Portfolios", "type": "folder" }, "items": [ { "info": { "name": "getBusinessPortfolios", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/marketers/meta/business/portfolios" } }, { "info": { "name": "updateBusinessPortfolio", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/marketers/meta/business/portfolios/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Meta Business Integrations", "type": "folder" }, "items": [ { "info": { "name": "getBusinessIntegrations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/marketers/meta/business/integrations" } }, { "info": { "name": "connectBusinessIntegration", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/marketers/meta/business/integrations" } }, { "info": { "name": "disconnectBusinessIntegrations", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v2/marketers/meta/business/integrations" } }, { "info": { "name": "enableBusinessIntegration", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v2/marketers/meta/business/integrations/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Meta Post Partnerships", "type": "folder" }, "items": [ { "info": { "name": "getMetaPostPartnershipRequests", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/marketers/meta/post-partnership-requests", "params": [ { "name": "activationIds", "value": "", "type": "query" } ] } }, { "info": { "name": "createMetaPostPartnershipRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v2/marketers/meta/post-partnership-requests" } } ] }, { "info": { "name": "Networks", "type": "folder" }, "items": [ { "info": { "name": "getAllNetworks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/networks" } } ] }, { "info": { "name": "OpenAISearch", "type": "folder" }, "items": [ { "info": { "name": "search", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/open-ai-search" } } ] }, { "info": { "name": "OptIn", "type": "folder" }, "items": [ { "info": { "name": "optIn", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/later/opt-in" } }, { "info": { "name": "optInUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/later/update" } }, { "info": { "name": "optInOptOut", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/webhooks/later/opt-out" } } ] }, { "info": { "name": "PaymentsLedger", "type": "folder" }, "items": [ { "info": { "name": "getPaymentsLedgerV2", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments-ledgerV2", "params": [ { "name": "fromDate", "value": "", "type": "query" }, { "name": "toDate", "value": "", "type": "query" }, { "name": "onlyMostRecent", "value": "", "type": "query" }, { "name": "paymentAccountIds", "value": "", "type": "query" }, { "name": "actionGroupIds", "value": "", "type": "query" }, { "name": "globalUserIds", "value": "", "type": "query" }, { "name": "rewardWinTypes", "value": "", "type": "query" }, { "name": "transactionStatuses", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "orderDirection", "value": "", "type": "query" }, { "name": "orderProperty", "value": "", "type": "query" }, { "name": "budgetReferenceId", "value": "", "type": "query" } ] } }, { "info": { "name": "getMostRecentLedgerRecordForRewardWin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments-ledgerV2/:rewardWinId", "params": [ { "name": "rewardWinId", "value": "", "type": "path" } ] } }, { "info": { "name": "getMostRecentLedgerRecordForStripeRewardWin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payments-ledgerV2/stripe/:rewardWinId", "params": [ { "name": "rewardWinId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ExchangeRates", "type": "folder" }, "items": [ { "info": { "name": "getExchangeRates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/exchange-rates", "params": [ { "name": "currencyCode", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "PaymentAccount", "type": "folder" }, "items": [ { "info": { "name": "getInstancePaymentAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts" } }, { "info": { "name": "createPaymentAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-accounts" } }, { "info": { "name": "getNetDepositsForPaymentAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts/net-deposits", "params": [ { "name": "paymentAccountIds", "value": "", "type": "query" } ] } }, { "info": { "name": "getPaymentAccountById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts/:paymentAccountId", "params": [ { "name": "paymentAccountId", "value": "", "type": "path" } ] } }, { "info": { "name": "recordAccountingTransaction", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/payment-accounts/:paymentAccountId/transactions", "params": [ { "name": "paymentAccountId", "value": "", "type": "path" } ] } }, { "info": { "name": "getStripeSupportedCurrencies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts/info/supported-currencies" } }, { "info": { "name": "getInstanceInternationalCurrencies", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts/info/instance" } }, { "info": { "name": "getPaymentAccountByInstanceId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-accounts/instance/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateInstanceInternationalCurrency", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/payment-accounts/instance/:instanceId", "params": [ { "name": "instanceId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateTransactionAndRewardWin", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/payment-accounts/:paymentAccountId/transactions/:transactionId/reward-wins/:rewardWinId", "params": [ { "name": "paymentAccountId", "value": "", "type": "path" }, { "name": "transactionId", "value": "", "type": "path" }, { "name": "rewardWinId", "value": "", "type": "path" } ] } }, { "info": { "name": "updateTransaction", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/payment-accounts/:paymentAccountId/transactions/:transactionId", "params": [ { "name": "paymentAccountId", "value": "", "type": "path" }, { "name": "transactionId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "PaymentAppAdmins", "type": "folder" }, "items": [ { "info": { "name": "getPaymentAppAdmin", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-app-admins" } } ] }, { "info": { "name": "PaymentProvider", "type": "folder" }, "items": [ { "info": { "name": "getInstancePaymentProviderApps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/payment-providers" } }, { "info": { "name": "configureMavrckProviderAppToInstance", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/mvk-payment-provider" } } ] }, { "info": { "name": "PinterestAuth", "type": "folder" }, "items": [ { "info": { "name": "authenticatePinterest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/pinterest/global-users/auth" } }, { "info": { "name": "authenticatePinterestRedirect", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/pinterest/global-users/redirect", "params": [ { "name": "code", "value": "", "type": "query" }, { "name": "state", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "CreatorProfileUpsert", "type": "folder" }, "items": [ { "info": { "name": "handleCreatorProfileUpsert", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/creator-profile-upsert" } } ] }, { "info": { "name": "ExpiringAccessTokens", "type": "folder" }, "items": [ { "info": { "name": "handleExpiringAccessToken", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/expiring-access-tokens" } } ] }, { "info": { "name": "SocialPresenceCreate", "type": "folder" }, "items": [ { "info": { "name": "handleSocialPresenceCreate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/social-presence-create" } } ] }, { "info": { "name": "SocialProfileUpdates", "type": "folder" }, "items": [ { "info": { "name": "handleSocialProfileUpdate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/social-profile-updates" } } ] }, { "info": { "name": "PointsAdmin", "type": "folder" }, "items": [ { "info": { "name": "getCommunityActionObjectiveDefinitions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/points-admin/action-objective-definition" } }, { "info": { "name": "setCommunityActionObjectiveDefinition", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/points-admin/action-objective-definition" } }, { "info": { "name": "getEngagementPointMapping", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/points-admin/engagement-point-mapping" } }, { "info": { "name": "setEngagementPointMapping", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/points-admin/engagement-point-mapping" } } ] }, { "info": { "name": "Polling Queue Management", "type": "folder" }, "items": [ { "info": { "name": "purgePollingQueue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/polling/management/queues/purge", "params": [ { "name": "queue", "value": "", "type": "query", "description": "The queue type to purge (instagram, instagram-story, or non-instagram)" } ] }, "docs": "Purge all messages from a specific polling queue.\nNote: Only one purge operation is allowed per queue every 60 seconds." }, { "info": { "name": "getAllPollingQueueStats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/polling/management/queues/stats" }, "docs": "Get statistics for all polling queues (Instagram, Instagram Story, Non-Instagram).\nReturns approximate message counts for each queue." }, { "info": { "name": "getSinglePollingQueueStats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/polling/management/queues/stats/single", "params": [ { "name": "queue", "value": "", "type": "query", "description": "The queue type to get stats for (instagram, instagram-story, or non-instagram)" } ] }, "docs": "Get statistics for a specific polling queue." } ] }, { "info": { "name": "PowerReviewsApp", "type": "folder" }, "items": [ { "info": { "name": "getPowerReviewsAppAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/power-reviews-app" } }, { "info": { "name": "createPowerReviewsApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/power-reviews-app" } } ] }, { "info": { "name": "PreviewPosts", "type": "folder" }, "items": [ { "info": { "name": "getPreviewPosts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/preview-posts", "params": [ { "name": "globalUserId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Product", "type": "folder" }, "items": [ { "info": { "name": "createPowerReviewsProduct", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/power-reviews-products" } }, { "info": { "name": "editPowerReviewsProduct", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/power-reviews-products" } } ] }, { "info": { "name": "Products", "type": "folder" }, "items": [ { "info": { "name": "getProducts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/products", "params": [ { "name": "title", "value": "", "type": "query" }, { "name": "powerReviewsAppId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "getProductsUsingToken", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-group-reports/products", "params": [ { "name": "title", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "public", "type": "folder" }, "items": [ { "info": { "name": "getPublicCampaignById", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v2/public/campaigns/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "MarketerFilterPreferences", "type": "folder" }, "items": [ { "info": { "name": "getMarketerFilterPreferences", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/marketer-filter-preferences", "params": [ { "name": "communityId", "value": "", "type": "query" }, { "name": "s4AccountId", "value": "", "type": "query" } ] } }, { "info": { "name": "setMarketerFilterPreferences", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/marketer-filter-preferences" } } ] }, { "info": { "name": "ReviewFormResponse", "type": "folder" }, "items": [ { "info": { "name": "ExportByCommunityIdAndCampaignId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/review-form-responses/:communityId", "params": [ { "name": "communityId", "value": "", "type": "path" }, { "name": "campaignId", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Instances", "type": "folder" }, "items": [ { "info": { "name": "getInstanceBranding", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/s4-instance-branding", "params": [ { "name": "hostname", "value": "", "type": "query" }, { "name": "brandingId", "value": "", "type": "query" } ] } }, { "info": { "name": "updateInstanceBranding", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/s4-instance-branding/:brandingId", "params": [ { "name": "brandingId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteInstanceBranding", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/s4-instance-branding/:brandingId", "params": [ { "name": "brandingId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ShareableLinksVisitors", "type": "folder" }, "items": [ { "info": { "name": "getShareableLinksVisitors", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shareable-links/visitors", "params": [ { "name": "sharedCipherId", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" }, { "name": "actionGroupId", "value": "", "type": "query" }, { "name": "dashboardType", "value": "", "type": "query" }, { "name": "fromDate", "value": "", "type": "query" }, { "name": "toDate", "value": "", "type": "query" } ] } }, { "info": { "name": "createShareableLinksVisitor", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shareable-links/visitors" } } ] }, { "info": { "name": "SharedCipher", "type": "folder" }, "items": [ { "info": { "name": "queryCiphers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shared-ciphers", "params": [ { "name": "actionGroupId", "value": "", "type": "query" } ] } }, { "info": { "name": "encodeCipher", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shared-ciphers" } }, { "info": { "name": "decodeCipher", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shared-ciphers/:cipher", "params": [ { "name": "cipher", "value": "", "type": "path" } ] } }, { "info": { "name": "updateOptions", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/shared-ciphers/:id/options", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "ShopifyAccount", "type": "folder" }, "items": [ { "info": { "name": "getInstanceShopifyAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shopify-accounts" } }, { "info": { "name": "createShopifyAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts" } }, { "info": { "name": "uninstallShopifyAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/uninstall" } }, { "info": { "name": "shopifyInstall", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shopify-accounts/install" } }, { "info": { "name": "shopifyAuth", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shopify-accounts/auth" } }, { "info": { "name": "connectShopifyApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/connect" } }, { "info": { "name": "uninstallShopifyApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/webhooks/uninstall" } }, { "info": { "name": "shopRedact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/webhooks/compliance/shop/redact" } }, { "info": { "name": "customerRedact", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/webhooks/compliance/customers/redact" } }, { "info": { "name": "customerDataRequest", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/shopify-accounts/webhooks/compliance/customers/data_request" } } ] }, { "info": { "name": "ShopifyAdminApi", "type": "folder" }, "items": [ { "info": { "name": "getOrderDetailsByDiscountCode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shopify/:discountRedeemCode/order-details", "params": [ { "name": "discountRedeemCode", "value": "", "type": "path" } ] } }, { "info": { "name": "getDiscount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/shopify/:discountCodeNodeId", "params": [ { "name": "discountCodeNodeId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "AdministrationAccountSlowMigration", "type": "folder" }, "items": [ { "info": { "name": "getUser", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/slow-migration/:username", "params": [ { "name": "username", "value": "", "type": "path" } ] } }, { "info": { "name": "validatePassword", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/slow-migration/:username", "params": [ { "name": "username", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "SnapchatContent", "type": "folder" }, "items": [ { "info": { "name": "triggerSnapchatContentRefreshJob", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/snapchat-content-refresh-jobs" } }, { "info": { "name": "refreshContentForProfile", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/snapchat-content-refresh-jobs/:creatorProfileId", "params": [ { "name": "creatorProfileId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Subscribers", "type": "folder" }, "items": [ { "info": { "name": "getSubscribers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscribers" } }, { "info": { "name": "createSubscriber", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/subscribers" } }, { "info": { "name": "updateSubscriber", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/subscribers/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "pingSubscriber", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/subscribers/:id/ping", "params": [ { "name": "id", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "SurveyResponse", "type": "folder" }, "items": [ { "info": { "name": "getSurveySummaries", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/survey-response-summary", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "getSurveyResponses", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:actionGroupId/survey-responses", "params": [ { "name": "actionGroupId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Surveys", "type": "folder" }, "items": [ { "info": { "name": "getSurveyByActionId", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action/:actionId/survey", "params": [ { "name": "actionId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "TikTokCampaignFields", "type": "folder" }, "items": [ { "info": { "name": "getTikTokCampaignFields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/tiktok-campaigns/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "upsertTikTokCampaignFields", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/tiktok-campaigns/:actionGroupId", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "InfluencerTopics", "type": "folder" }, "items": [ { "info": { "name": "getInfluencerTopics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/influencer-topics" } }, { "info": { "name": "setInfluencerTopics", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/influencer-topics" } } ] }, { "info": { "name": "Topics", "type": "folder" }, "items": [ { "info": { "name": "getTopics", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/topics", "params": [ { "name": "orderBy", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "labelParam", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "TrackingLinks", "type": "folder" }, "items": [ { "info": { "name": "getTrackingLinks", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/action-groups/:id/tracking-links", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "globalUserId", "value": "", "type": "query" } ] } }, { "info": { "name": "updateTrackingLink", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/action-groups/:id/tracking-links/:trackingLinkId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "trackingLinkId", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteTrackingLink", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/action-groups/:id/tracking-links/:trackingLinkId", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "trackingLinkId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "Translations", "type": "folder" }, "items": [ { "info": { "name": "fetchAvailableLocales", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/translations/fetch-available-locales" } } ] }, { "info": { "name": "TikTok TTCM", "type": "folder" }, "items": [ { "info": { "name": "purgeTikTokQueue", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/ttcm/management/queues/purge", "params": [ { "name": "queue", "value": "", "type": "query" } ] } }, { "info": { "name": "getTikTokQueueStats", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ttcm/management/queues/stats" } } ] }, { "info": { "name": "URLMetadata", "type": "folder" }, "items": [ { "info": { "name": "getURLMetadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/url-metadata", "params": [ { "name": "url", "value": "", "type": "query" }, { "name": "s3Upload", "value": "", "type": "query" }, { "name": "s3Directory", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "AccountInvitations", "type": "folder" }, "items": [ { "info": { "name": "getAccountInvitations", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/account-invitations", "params": [ { "name": "communityId", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "postAccountInvitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/account-invitations" } }, { "info": { "name": "putAccountInvitation", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/account-invitations/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "deleteAccountInvitation", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/account-invitations/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "refreshAccountInvitation", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/account-invitations/:id/refresh", "params": [ { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "acceptAccountInvitation", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/account-invitations/accept", "params": [ { "name": "signature", "value": "", "type": "query" } ] } }, { "info": { "name": "postRegistration", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/account-invitations/post-registration", "params": [ { "name": "signature", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "AdministratorAccounts", "type": "folder" }, "items": [ { "info": { "name": "getAdministratorAccounts", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/administrator_accounts", "params": [ { "name": "email", "value": "", "type": "query" }, { "name": "communityId", "value": "", "type": "query" }, { "name": "excludeRootAccounts", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" } ] } }, { "info": { "name": "getAdministratorAccount", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/administrator_accounts/:username", "params": [ { "name": "username", "value": "", "type": "path" } ] } }, { "info": { "name": "validateAdministratorAccount", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/administrator_accounts/:username", "params": [ { "name": "username", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "GlobalUserMerge", "type": "folder" }, "items": [ { "info": { "name": "getGlobalUserMerges", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users-merge/search" } }, { "info": { "name": "globalUserMerge", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/global-users-merge" } } ] }, { "info": { "name": "Conversions", "type": "folder" }, "items": [ { "info": { "name": "createConversion", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/conversion-pinger" } } ] }, { "info": { "name": "WebPluginWidgets", "type": "folder" }, "items": [ { "info": { "name": "getWebPluginWidgets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/web-plugin/widgets", "params": [ { "name": "communityId", "value": "", "type": "query" }, { "name": "initializationRuleType", "value": "", "type": "query" } ] } } ] }, { "info": { "name": "Yotpo", "type": "folder" }, "items": [ { "info": { "name": "getYotpoApps", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/yotpo-apps" } }, { "info": { "name": "createYotpoApp", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/yotpo-apps" } } ] }, { "info": { "name": "YtbcActionGroupChannels", "type": "folder" }, "items": [ { "info": { "name": "getActionGroupCampaignCode", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ytbc/action-groups/:actionGroupId/campaign-code", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "getActionGroupYoutubeChannel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ytbc/action-groups/:actionGroupId/youtube-channel", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "setActionGroupYoutubeChannel", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/ytbc/action-groups/:actionGroupId/youtube-channel", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } }, { "info": { "name": "clearActionGroupYoutubeChannel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/ytbc/action-groups/:actionGroupId/youtube-channel", "params": [ { "name": "actionGroupId", "value": "", "type": "path" } ] } } ] }, { "info": { "name": "YtbcBrandChannels", "type": "folder" }, "items": [ { "info": { "name": "validateBrandYoutubeChannel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/ytbc/brand-channels/validate" } }, { "info": { "name": "getBrandYoutubeChannel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/ytbc/brands/:brandId/youtube-channel", "params": [ { "name": "brandId", "value": "", "type": "path" } ] } }, { "info": { "name": "setBrandYoutubeChannel", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/ytbc/brands/:brandId/youtube-channel", "params": [ { "name": "brandId", "value": "", "type": "path" } ] } }, { "info": { "name": "clearBrandYoutubeChannel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/ytbc/brands/:brandId/youtube-channel", "params": [ { "name": "brandId", "value": "", "type": "path" } ] } } ] } ], "bundled": true }