Create a folder with POST and /config

The following is an example workflow for using POST with /config to create or modify a folder:

  1. Acquire the authorization token, along with the company and organization short names for the folder to be created or modified. Find this information using the UI on the settings icon Settings > Accounts screen. The following must be supplied with any POST call to /config:
    Token

    A company API token with write permissions for the target organization.

    Company short name

    The reference configured for a company when it is first created.

    Organization short name

    The reference configured for an organization when it is first created.

    Company and organization information may also retrieved using GET with /config.

  2. Prepare a JSON file with the folder's configuration parameters. Using POST to create folders with the /config endpoint requires the configuration of many folder properties; as a result, it is strongly recommended to POST a JSON file with the folder's required properties.
  3. Make a POST request to the /config endpoint with the JSON file as a parameter. See the following topics for more information:

    • /config demonstrates several types of request

    • Entity JSON shows the format for different kinds of system entities

  4. If the folder exists, its configuration is changed to the submitted parameters. If the folder does not exist, it is created with the submitted parameters.
  5. Verify the folder's configuration using the Monitored Folders UI or a GET request to the /config endpoint. Refer to the following topics for more information:

    • Administration shows how to view a list of folders on the Monitored Folders screen.

    • /config demonstrates how to retrieve a folder's configuration settings using the API.

    • GET status of all system folders demonstrates how to retrieve a folder's ASR processing status using the API.