Skip to main content
POST
/
api
/
ftp_mapping_groups
/
{mapping_group_id}
/
mappings
Create a FTP mapping
curl --request POST \
  --url https://clarus-api.com/api/ftp_mapping_groups/{mapping_group_id}/mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "ftp_mappings",
    "attributes": {
      "account_id": 5,
      "account_in_file": "ACME",
      "customer_id": 200,
      "customer_in_file": "CUST-200",
      "delivery_address_id": 91,
      "delivery_address_in_file": "DEL-A",
      "collection_address_id": 17,
      "collection_address_in_file": "COL-Z",
      "mapping_fields": [
        {
          "file_format": "csv"
        }
      ]
    }
  }
}
'
{
  "id": 5
}

​
Request Structure

{
  "data": {
    "type": "ftp_mappings",
    "attributes": {
      "account_id": 5,
      "account_in_file": "ACME",
      "customer_id": 200,
      "customer_in_file": "CUST-200",
      "mapping_fields": [{ "file_format": "csv" }]
    }
  }
}
Maps identifiers found in inbound files (the *_in_file values) to internal Clarus records (account, customer, delivery/collection address). All fields are optional.

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

​
mapping_group_id
integer
required

The FTP mapping group ID

Body

application/json
​
data
object
required

Response

Created successfully

Created record