Skip to main content
POST
Send document to FTP

Request Format

This endpoint accepts plain JSON (not JSON:API format):

Behavior

  • The document is uploaded to the FTP server asynchronously via a background job
  • The FTP user must have download direction (i.e., files flow from ClarusWMS to the FTP server)
  • Returns 204 No Content on success

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Path Parameters

id
integer
required

The unique identifier of the document to send

Body

application/json
ftp_user_id
integer
required

ID of the FTP user to send the document to. Must have download direction.

Response

Operation completed successfully with no content to return