You can manage API documents using the Platform Automation API for tasks including:

Details of required parameters, available methods and endpoint urls can be found within FaUAPI API document task schema documentation.

Creating an API document

You can use this endpoint to add an API document. View details on the url and any parameters required to use this endpoint.

Listing all API documents

You can use this endpoint to list all API documents. View details on the url and any parameters required to use this endpoint.

Retrieving an API document

You can use this endpoint to retrieve a specific API document. View details on the url and any parameters required to use this endpoint.

Updating an API document

You can use this endpoint to update an API document. View details on the url and any parameters required to use this endpoint.

Deleting an API document

You can use this endpoint to delete an API document. View details on the url and any parameters required to use this endpoint.

Example

An example showing how to use a Platform Automation API endpoint for automation can found in the Example automation using an api endpoint section.