Multi FileFeeds

Create a Multi FileFeed

Changed on

Creates a new Multi FileFeed with the specified templates. At least one template must be provided. Template keys must be unique within the request.

Optional parameters allow configuring a source (SFTP or S3), destination (SFTP or S3), event webhook, and custom metadata at creation time.

If folder_id is not provided, the Multi FileFeed is placed in the organization's default Multi FileFeed folder.

post/v0/multi-file-feeds

Request

  • Base URL
    https://api.oneschema.co
  • URL
    https://api.oneschema.co/v0/multi-file-feeds
  • Auth
    API key in header X-API-KEY

Request body

namestring required

The name for the new Multi FileFeed. Must be unique within the organization.

folder_idinteger

ID of the folder to place this Multi FileFeed in. If not provided, the default Multi FileFeed folder is used.

multi_filefeed_event_webhook_keystring

Key of an existing event webhook to attach to this Multi FileFeed

custom_metadataobject nullable

JSON object with custom metadata to associate with the Multi FileFeed

Response

Successful response

idinteger
namestring
folder_idinteger

ID of the folder containing this Multi FileFeed

custom_metadataobject

Changes

    • breaking

      removed from the request property anyOf list

    • breaking

      removed from the request property anyOf list

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added to the request property anyOf list

    • info

      added to the request property anyOf list

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status