Skip to main content
POST
Error

Authorizations

x-cdata-authtoken
string
header
required

Body

application/json
ConnectorId
string
required

The Id of the connector sending the file.

WorkspaceId
string

The Id of the workspace containing the connector to use to send the file.

PortId
string

The Id of the port to use for the file transfer connection.

MessageId
string

The Id associated with this message for tracking and correlation.

File
string

The name of the file to send.

Subfolder
string

The subfolder path where the file is located or should be organized.

Attachment#
string

The file attachment to send. This name must match a message name in the Send folder for the attachment to be included. The # enables you to increment and include multiple attachments (such as Attachment1, Attachment2).

FormatResult
string

Whether to format the output for readability or return it in raw format. The default is False. Available values are 'True, False'.

Response

The action result

MessageId
string

The Id assigned to this sent message for tracking and reference.

File
string

The name of the sent file.