Ui.Marketing API
      Back to home
      1. Help Center
      2. Resources
      3. Ui.Marketing API

      How to use the Proposal API

      Overview of Ui.Marketing Proposal API

      The Proposals API provides our Partners' the capability to retrieve proposals without requiring the use of our proprietary Proposals tool in UI.Marketing. Once the proposal is created, the API partner can edit a proposal by concatenating the URL with the external API's Proposal data. 

       
      Common Use Cases
       

      NOTE: If you cannot access any of the following pages or need access to a specific feature, please get in touch with our Support team for the appropriate permissions.

       
       

      Proposal Products

       

      Use Case

      Description

      products

      This indicates the start of proposal product data

      id

      The product Id is associated with the advertising product that is nested underneath a proposal

      proposalId

      With a proposalId provided, you can at most receive 1 proposal back (the one that matches the id), or 0 proposals

      productKey

      The name of the product associated with the product

      budget

      The budget for the product

      proposedRetailRate

      If the retail rate is adjusted, the new retail rate is associated with a campaign.

      retailRate

      The retail rate that is being charged to the Advertiser

      wholesaleRate

      The retail rate that is being charged to our partner

      startDate

      The start date of a specific proposal

      endDate

      The end date of a particular proposal

      monthlyAllocations

      The monthly allocations that are associated with a campaign underneath a proposal

      managementFee

      The management fee is associated with a proposal advertising product

      Proposal

      		 

      Use Case

      Description

      id

      The proposal Id is associated with the products

      externalId

      The externalId is the data point that will allow a third party to store their Id to associate it back to a proposal

      orderId

      Once a proposal is submitted into order, an order Id is associated with that proposal

      startDate

      The start date of the advertising product underneath a proposal specific to an individual campaign

      endDate

      The end date of the advertising product underneath a proposal specific to an individual campaign

      createdDate

      The date the proposal was created

      updatedDate

      The last updated date of a proposal

      name

      The name of the proposal

      advertiserId

      The Advertiser Id that is associated with the proposal

      authorizationIds

      An authorization ID is needed and used as a parameter to pass into an EAPI call to get proposal or order data in a response.

      requestor

      The user that is requesting the proposal

      budget

      The total budget of the proposal

      Example Response:

      • Status: 200 OK

      GET https://api.adcellerant.com/proposals 

      Header Specifications

      • Authorization

      Input Specifications

      • Parameters

        • hierarchId (Long, required)

        • externalId (String, required)

        • updatedAfter (Date String, optional, ISO format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX)

        • pageNumber (Integer, optional, defaults to 1)

        • pageSize (Integer, optional, defaults to 25)

          • max size = 50

      Output Specifications

      • Pagination Information

        • Total number of results

        • Total number of pages

        • The current page number

        • The page size

      • Results

        • The page of proposals that match the query params

      Example Request: