Skip to main content
POST
/
api
/
ftp_users
Create an FTP user
curl --request POST \
  --url https://clarus-api.com/api/ftp_users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "ftp_users",
    "attributes": {
      "direction": "upload",
      "name": "Acme Inbound Feed",
      "username": "acme_inbound",
      "password": "S3cure-Pass!",
      "password_confirmation": "S3cure-Pass!"
    }
  }
}
'
{
  "data": {
    "id": "31",
    "type": "ftp_users",
    "attributes": {
      "direction": "upload",
      "name": "Acme Inbound Feed",
      "username": "acme_inbound",
      "active": true
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "ftp_users",
    "attributes": {
      "direction": "upload",
      "name": "Acme Inbound Feed",
      "username": "acme_inbound",
      "password": "S3cure-Pass!",
      "password_confirmation": "S3cure-Pass!"
    }
  }
}

​
Key Fields

FieldRequiredDescription
directionYesdownload or upload
nameYesDisplay name
usernameYesLogin username (min 6 chars, unique)
passwordYesPassword (write-only)
password_confirmationYesMust match password

​
Notes

  • On update, omitting password (or sending it blank) leaves the existing password unchanged.
  • Creating an upload FTP user auto-provisions a default set of import templates.

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.

Body

application/json
​
data
object
required

Response

N ftp user created successfully

​
data
object