Skip to main content
POST
Create a FTP mapping

Request Structure

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.

FlowAuthorization Code
Authorization URL
https://clarus-api.com/oauth/authorize
Token URL
https://clarus-api.com/oauth/token
FlowClient Credentials
Token URL
https://clarus-api.com/oauth/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