> ## Documentation Index > Fetch the complete documentation index at: https://docs.topsort.com/llms.txt > Use this file to discover all available pages before exploring further. # Update an exclusive sponsored brand campaign. > Partially update an exclusive sponsored brand campaign. Only V2 campaigns are publicly addressable. ## OpenAPI ````yaml /openapi.json patch /public/v1/campaign-service/campaigns/sponsored-brand/exclusive/{campaign_id} openapi: 3.1.0 info: title: Topsort Endpoints v2 API Reference description: > In order for a storefront to be able to run auctions in Topsort and report auction-related events back to Topsort, both the `/v2/auctions` and `/v2/events` endpoints must be integrated. Below are the endpoint and model definitions for each. contact: email: wicha@topsort.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://assets.topsort.com/Topsort_logo_icon_dark.svg backgroundColor: '#fff' altText: Topsort version: 2.0.0 servers: - url: https://api.topsort.com description: Base API URL security: [] tags: - name: Auctions description: >- An auction determines which products should be promoted based on the vendors' bids. - name: Events description: >- Events are sent to Topsort as part of the attribution and reporting journey. - name: Toptimize description: > An out-of-the-box solution for prediction, ranking, retrieval, and other elements of ad selection. - name: Toppie API description: Toppie management API. - name: Campaign API description: Full-featured campaign management API for banners and sponsored listings. - name: Catalog API description: Products catalog management API. - name: Billing API description: Marketplace and Vendor Billing management API. - name: Reporting API description: Marketplace, Vendor, Campaign, and product reporting API. - name: Invitation API description: Vendor invitations management API. - name: User API description: User management API. - name: Webhooks API description: Webhooks API that allows event-driven automation. - name: Assets API description: Assets management API. - name: Segments Service description: Segments Service. - name: Forecasting Service description: Toptimize Forecasting Service. - name: Offsite Ads API description: Offsite Ads API that allows to manage offsite ads campaigns. - name: Media API description: Ad configuration API. - name: Placement API description: Placement management API for sponsored brand slots. - name: Export API description: Request an asynchronous Parquet export of your performance data. paths: /public/v1/campaign-service/campaigns/sponsored-brand/exclusive/{campaign_id}: patch: tags: - Campaign API summary: Update an exclusive sponsored brand campaign. description: >- Partially update an exclusive sponsored brand campaign. Only V2 campaigns are publicly addressable. operationId: public_update_exclusive_sb_campaign parameters: - name: campaign_id in: path required: true schema: type: string format: uuid description: The ID of the campaign. title: Campaign Id description: The ID of the campaign. - name: vendor_id in: query required: true schema: type: string minLength: 1 description: The ID of the vendor. title: Vendor Id description: The ID of the vendor. requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/Advanced_APIs_PublicExclusiveSponsoredBrandCampaignUpdateRequest responses: '200': description: Successful Response content: application/json: schema: $ref: >- #/components/schemas/Advanced_APIs_PublicExclusiveSponsoredBrandCampaign '400': description: Invalid wallet or sponsored brand status update. '404': description: Campaign, wallet, or slot not found. '409': description: Exclusive campaign conflict. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/Advanced_APIs_HTTPValidationError' security: - Advanced_APIs_HTTPBearer: [] components: schemas: Advanced_APIs_PublicExclusiveSponsoredBrandCampaignUpdateRequest: properties: name: title: Name description: The name of the campaign. examples: - Bola-Bola Ad campaign oneOf: - type: string minLength: 1 - type: 'null' isActive: title: Isactive description: Whether the campaign should be activated. oneOf: - type: boolean - type: 'null' schedule: title: Schedule description: The schedule for the campaign. oneOf: - items: $ref: '#/components/schemas/Advanced_APIs_Schedule' type: array maxItems: 1 - type: 'null' status: description: The approval status of the sponsored brand campaign. oneOf: - $ref: '#/components/schemas/Advanced_APIs_CampaignStatus' - type: 'null' sponsoredBrandRejectionReason: description: The reason for rejecting the sponsored brand campaign. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicSponsoredBrandRejectionReason - type: 'null' exclusivityPrice: title: Exclusivityprice description: >- The price to pay daily for the campaign to run, in minor units of currency. oneOf: - type: integer exclusiveMinimum: 0 - type: 'null' impressionsThreshold: title: Impressionsthreshold description: Impressions allowed for the campaign before it is stopped. oneOf: - type: integer - type: 'null' exclusivityPercentage: title: Exclusivitypercentage description: Percentage of auctions the campaign will be exclusive in. oneOf: - type: number - type: 'null' multiplierConfig: description: The multipliers of the campaign. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignMultiplierConfig - type: 'null' targetingFilters: description: The segments that the campaign will participate for. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignTargetingFilters - type: 'null' exclusionFilters: description: The segments that the campaign will not target. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignExclusionFilters - type: 'null' content: title: Content description: >- Dynamic content for the placement template. Omit the key to leave bid content unchanged. Send the object to store it on every bid. oneOf: - additionalProperties: true type: object - type: 'null' type: object title: PublicExclusiveSponsoredBrandCampaignUpdateRequest description: Request body for updating a public exclusive sponsored brand campaign. Advanced_APIs_PublicExclusiveSponsoredBrandCampaign: properties: campaignId: type: string format: uuid title: Campaignid description: The ID of the campaign. marketplaceId: type: string format: uuid title: Marketplaceid description: The ID of the marketplace. vendorId: type: string title: Vendorid description: The external vendor ID. name: type: string minLength: 1 title: Name description: The name of the campaign. examples: - Bola-Bola Ad campaign isActive: type: boolean title: Isactive description: Whether the campaign is active. status: $ref: '#/components/schemas/Advanced_APIs_CampaignStatus' description: The approval status of the sponsored brand campaign. externalCampaignId: title: Externalcampaignid description: The external ID of the campaign in the marketplace. oneOf: - type: string - type: 'null' slotId: type: string title: Slotid description: >- The external slot ID where the exclusive sponsored brand campaign is shown. schedule: items: $ref: '#/components/schemas/Advanced_APIs_Schedule' type: array maxItems: 1 minItems: 1 title: Schedule description: The schedule for the campaign. content: additionalProperties: true type: object title: Content description: Dynamic content validated against the slot's JSON template. walletId: title: Walletid description: The uuid of the wallet used with this campaign. oneOf: - type: string format: uuid - type: 'null' createdAt: type: string format: date-time title: Createdat description: When this campaign was created. updatedAt: type: string format: date-time title: Updatedat description: When this campaign was last updated. bidType: type: string const: exclusive title: Bidtype description: The bidding type of the campaign. default: exclusive chargeType: $ref: '#/components/schemas/Advanced_APIs_ExclusiveCampaignChargeType' description: How exclusive campaigns are charged. Only daily is allowed. default: DAILY exclusivityPrice: type: integer title: Exclusivityprice description: >- The price to pay daily for the campaign to run, in minor units of currency. impressionsThreshold: title: Impressionsthreshold description: Impressions allowed for the campaign before it is stopped. oneOf: - type: integer - type: 'null' exclusivityPercentage: title: Exclusivitypercentage description: Percentage of auctions the campaign will be exclusive in. oneOf: - type: number - type: 'null' position: type: integer maximum: 20 minimum: 1 title: Position description: The rank the ad will have in the auction. default: 1 multiplierConfig: description: The multipliers of the campaign. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignMultiplierConfig - type: 'null' targetingFilters: description: The segments that the campaign will participate for. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignTargetingFilters - type: 'null' exclusionFilters: description: The segments that the campaign will not target. oneOf: - $ref: >- #/components/schemas/Advanced_APIs_PublicCampaignExclusionFilters - type: 'null' type: object required: - campaignId - marketplaceId - vendorId - name - isActive - status - slotId - schedule - content - createdAt - updatedAt - exclusivityPrice title: PublicExclusiveSponsoredBrandCampaign description: An exclusive sponsored brand campaign returned by the public API. Advanced_APIs_HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/Advanced_APIs_ValidationError' type: array title: Detail type: object title: HTTPValidationError Advanced_APIs_Schedule: properties: startDate: type: string format: date-time title: Startdate description: The start time of the schedule. endDate: type: string format: date-time title: Enddate description: The end time of the schedule. type: object required: - startDate - endDate title: Schedule description: The schedule for the campaign. Advanced_APIs_CampaignStatus: type: string enum: - approved - pending - rejected title: CampaignStatus description: Represents the review status of a banner campaign. Advanced_APIs_PublicSponsoredBrandRejectionReason: properties: declineReason: type: string title: Declinereason description: The reason the campaign was rejected. reasonDetails: title: Reasondetails description: Additional details about the rejection reason. oneOf: - type: string - type: 'null' type: object required: - declineReason title: PublicSponsoredBrandRejectionReason Advanced_APIs_PublicCampaignMultiplierConfig: properties: isActive: type: boolean title: Isactive description: Whether the multiplier is active. multipliers: items: $ref: '#/components/schemas/Advanced_APIs_PublicUserSegmentMultiplier' type: array maxItems: 3 title: Multipliers description: List of multipliers. type: object required: - isActive - multipliers title: PublicCampaignMultiplierConfig description: The multiplier configuration for the campaign. Advanced_APIs_PublicCampaignTargetingFilters: properties: isActive: type: boolean title: Isactive description: Whether the filter is active. targetingFilters: items: $ref: '#/components/schemas/Advanced_APIs_PublicTargetingFilter' type: array maxItems: 3 title: Targetingfilters description: List of filters. type: object required: - isActive - targetingFilters title: PublicCampaignTargetingFilters description: The segments of users that the campaign will participate for. Advanced_APIs_PublicCampaignExclusionFilters: properties: isActive: type: boolean title: Isactive description: Whether the filter is active. exclusionFilters: items: $ref: '#/components/schemas/Advanced_APIs_PublicExclusionFilter' type: array maxItems: 3 title: Exclusionfilters description: List of exclusion filters. type: object required: - isActive - exclusionFilters title: PublicCampaignExclusionFilters description: The segments of users that the campaign will not target. Advanced_APIs_ExclusiveCampaignChargeType: type: string enum: - DAILY title: ExclusiveCampaignChargeType description: Charge types for exclusive campaigns. Advanced_APIs_ValidationError: properties: loc: items: oneOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError Advanced_APIs_PublicUserSegmentMultiplier: properties: type: type: string const: user_segment title: Type description: Multiplier type. segmentId: type: string title: Segmentid description: User segment ID. multiplier: type: number multipleOf: 0.1 maximum: 5 minimum: 0.1 title: Multiplier description: >- Multiplier value. Values above 1 raise the bid for the segment, values below 1 lower it. Between 0.1 and 5.0, with at most 1 decimal place. examples: - 0.5 type: object required: - type - segmentId - multiplier title: PublicUserSegmentMultiplier Advanced_APIs_PublicTargetingFilter: properties: type: type: string const: user_segment title: Type description: Segment type. segmentId: type: string title: Segmentid description: User segment ID. type: object required: - type - segmentId title: PublicTargetingFilter description: >- A singular instance of a targeting filter to be associated with a campaign. Advanced_APIs_PublicExclusionFilter: properties: type: type: string const: user_segment title: Type description: Segment type. segmentId: type: string title: Segmentid description: User segment ID. type: object required: - type - segmentId title: PublicExclusionFilter description: >- A singular instance of a exclusion filter to be associated with a campaign. securitySchemes: Advanced_APIs_HTTPBearer: type: http description: >- A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.