Legal Agreement Maintenance

Add / Maintenance API Legal Agreements.

Table of Contents

1. What is the legal agreement maintenance process?
2. Who can update legal agreement content?
3. How do I add a legal agreement?
4. What are the content guidelines for legal agreements?
5. How do I activate a legal agreement?
6. How do I deactivate a legal agreement?
7. How do I edit legal agreement details?
8. How do I delete a legal agreement?
9. How do I download a legal agreement report?

What is the legal agreement maintenance process?

The legal agreement maintenance process includes the following steps.

• Step 1: Update and Upload Content: All legal agreement content must be developed and maintained outside the platform in your own HTML editor. Each time a content update is made, it must be uploaded to the site. See Content Development Guidelines.
• Step 2: Activate / Deactivate Content: After you have published a legal agreement, it must be activated so it is available for selection in the Add a New API Wizard, and visible in the platform API Access Wizard. This is accomplished by clicking the Activate button in the Status section of the Agreements Summary screen, assigning a name and description to the legal agreement, and saving the configuration. Users that are not API Providers / Administrators cannot view a legal agreement in the API wizards, or in the API > Legal section until it has been activated. You can restrict visibility of the legal agreement by clicking the Deactivate button (see How do I deactivate a legal agreement?). After the initial legal agreement activation, you can also edit the legal agreement name and description (see How do I edit legal agreement details?).
• Step 3: (Optional): Report Statistics: If you would like to view statistics of legal agreement activation or deactivation activity, you can click the Report button and download a CSV file that includes the legal agreement name and username/date/time stamp of when the legal agreement was activated or deactivated.
• See Content Development Guidelines for more information on the legal agreement content development and maintenance.

Back to top

Who can update legal agreement content?

API legal agreements can be updated by the owner of the API (API Administrator). The API Administrator can also assign team members that have accepted invitations to be administrators of the API with legal agreement update privileges.

Back to top

How do I add a legal agreement?

You can add a legal agreement by uploading content using the File Explorer. See Content Development Guidelines for details.

Back to top

What are the content guidelines for legal agreements?

The platform provides a set of content development guidelines for all types of content including legal agreements. See Content Development Guidelines for details.

Back to top

How do I activate a legal agreement?

After legal agreements have been uploaded and the name and description have been assigned, the agreements must be activated. An activated legal agreement displays in the platform API Access Wizard where it can be reviewed and accepted as part of the API access request process.

To activate a legal agreement:

1. Navigate to API > API Name > Legal.
2. Click Manage Agreements.
3. Choose which legal agreement you would like to activate. In the Status column, click Activate. The legal agreement will be activated and added to the platform API Access Wizard.

Back to top

How do I deactivate a legal agreement?

If for any reason it becomes necessary to discontinue use of a particular legal agreement, you can deactivate it and remove it from displaying in the platform API Access Wizard.

To deactivate a legal agreement:

1. Navigate to API > API Name > Legal.
2. Click Manage Agreements.
3. Choose which legal agreement you would like to deactivate. In the Status column, click Deactivate. The legal agreement will be deactivated and removed from the platform API Access Wizard.

Back to top

How do I edit legal agreement details?

After you have activated a legal agreement you can update the name and description using the Edit function. This information displays on the Agreements Summary listing of your legal agreement. The "Name" assignment also is used as the hyperlinked display name of the legal agreement on the Legal page. The Edit function in the Status column is used to update legal agreement display information.

To edit a legal agreement:

1. Navigate to API > API Name > Legal.
2. Click Manage Agreements.
3. Choose which legal agreement you would like to edit. In the Status column, click Edit. The Edit pop-up displays.
4. Specify a Name and Description for your legal agreement. Click Save to commit your changes.

Back to top

How do I delete a legal agreement?

Legal agreements can only be deleted when they are in a Draft state. After a legal agreement has been activated, they are registered as part of the API's contract and cannot be deleted.

To delete a legal agreement:

1. Navigate to API > API Name > Legal.
2. Click Manage Agreements. Verify that the legal agreement you would like to delete is assigned a Draft status.
3. Click Legal in the left navigation to return to the home page. Click Manage Files.
4. Select a legal agreement you would like to delete, uncheck the Publish checkbox, and click the red x in the Actions column. Click OK when you receive the delete confirmation message. The legal agreement is deleted.

Back to top

How do I download a legal agreement report?

If you would like to view statistics of legal agreement activation or deactivation activity, you can download a CSV file that includes the legal agreement name and username/date/time stamp of when the legal agreement was activated or deactivated.

To download a legal agreement report:

1. Navigate to API > API Name > Legal.
2. Click Manage Agreements.
3. Choose which legal agreement you would like to view a report for. In the Status column, click Report. From the file dialog, navigate to the directory where you would like to save the .CSV file and click Save.

Back to top