1.0 Objective
The purpose of this document is to guide a user through creation and management of Publishing API v4+ Model IDs (modelId
) within our system, which are used for integration purposes.
2.0 Table of Contents
3.0 Intended Audience
Company Administrators within Agreement Express
4.0 Prerequisites
-
Target Company needs to have at least one transaction
-
User needs to be at least Company Admin level in order to access Administration → Transactions section
5.0 Instructions
5.1 Create a modelId
Steps:
-
In the AEX Workspace open Administration then select Transactions
-
Identify the transaction you wish to create a
modelId
for, click the three-dot menu and select Manage API Model IDs -
In the new window click CREATE NEW MODEL ID
-
Once the
modelId
was created, click SAVE -
The
modelId
will appear. Parameters, such as Publisher Email or Publish As Draft option can be adjusted as needed
Note the modelId
for v4 publishing request purposes.