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.
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.
Endpoint
Example Response:
-
Status: 200 OK
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: