support Contact support
    • Kamino
    • Developers
    • Kamino platform API integration
    • Manage guaranteed campaigns (API v2)

    Create and manage guaranteed campaigns

    Table of Contents

    Overview Main endpoints Campaign attributes

    Overview

    This article explains how to create and manage guaranteed campaigns, and how to retrieve all guaranteed campaigns that are associated with a specified account.

    Main endpoints

    Method Endpoint Description Reference
    GET https://api.kaminoretail.dev/v2/campaigns Retrieve all campaigns associated with the specified account. List campaigns
    GET https://api.kaminoretail.dev/v2/campaigns/{campaign_id} Retrieve details of a specific campaign by its ID. Get a campaign
    PATCH https://api.kaminoretail.dev/v2/campaigns/{campaign_id} Update the status of a campaign. Patch a campaign
    POST https://api.kaminoretail.dev/v2/campaigns Create a new campaign. Create a campaign
    PUT https://api.kaminoretail.dev/v2/campaigns/{campaign_id} Update details of a specific campaign by its ID. Update a campaign

    Campaign attributes

    The following table defines common campaign attributes. The complete list of attributes is available in the Create a campaign. If you have questions, contact the Equativ team.

    Attribute Data type Description Example
    accountId integer Account ID associated with the campaign, which is generated internally by Equativ. 123456
    allocatedBudget integer Sum of budgets attributed to all line items that are associated with this campaign. 1000
    attribution_post_click number

    Post-click attribution window in days. 

     

    The accepted value is an integer from 0 to 30. 

     

    The default value is 14. 

     

    For more information, see Configure sales attribution.

    		 14
    attribution_post_view number

    Post-view attribution window in days. 

     

    The accepted value is an integer from 0 to 30. 

     

    The default value is 14. 

     

    For more information, see Configure sales attribution.

    		 14
    brand integer Unique identifier of the brand, name, and logo URL (optional). 12
    budget integer

    Campaign lifetime spend cap. 

     

    The accepted value must be equal to or greater than zero.

    		 1000
    buyer string The entity that pays for the advertisement. This information and the brand are used for the Digital Services Act (DSA) pop-up. Kamino
    campaignType string

    Campaign type. 

     

    The accepted value is monetization.

    		 monetization
    dates.lower array[string<date-time>] Line item start date using an ISO 8601 UTC timestamp. 2025-09-01T14:15:22Z
    dates.upper array[string<date-time>] Line item end date using an ISO 8601 UTC timestamp. 2025-09-15T14:15:22Z
    id integer Campaign ID, which is generated internally by Equativ. 123456
    insertionOrder string

    An insertion order (IO) is a document, often a contract, that outlines the terms of the campaign. This includes the start and end dates, placement, ad format, size, and pricing model of the campaign. 

    This field is optional.

    		 Test_Kamino_092025
    name string Campaign name, which must be unique. My amazing campaign name
    products array[string] List of product IDs from promoted products in the campaign. The IDs must match the retailer_product_id field from the Products Catalog Feed. ["1234", "4536-abc", "EFGH"]
    status string

    Campaign status. 

     

    To understand the conditions that cause a status change, see Campaign status. 

     

    Accepted values include programming, review, approved, rejected, running, paused, ended, and deleted.

    		 programming
    website integer Unique identifier of the website that is associated with this campaign. 8

    The Digital Services Act only applies to countries in the European Union.

     

    For more information about product management, see Product catalog attributes.

     

    RELATED ARTICLES