Skip to main content
PATCH
/
api
/
import_configurations
/
{id}
Update an import configuration
curl --request PATCH \
  --url https://clarus-api.com/api/import_configurations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "import_configurations",
    "attributes": {
      "name": "<string>",
      "settings": [
        {
          "setting_type": "delimiter",
          "value": ","
        }
      ],
      "pre_processors": [
        {
          "action": "dig",
          "configuration": {
            "path": "root.GoodsOut"
          },
          "sequence": 1
        }
      ],
      "automatic_processing_flows": [
        {
          "code": "process_order",
          "name": "Process Order",
          "sequence": 1,
          "conditions": {},
          "processing_actions": [
            {
              "action": "find_resource",
              "configuration": {
                "resource_name": "account",
                "resource_attribute": "code",
                "index": "AccountCode"
              }
            }
          ]
        }
      ],
      "manual_processing_flows": [
        {
          "code": "process_order",
          "name": "Process Order",
          "sequence": 1,
          "conditions": {},
          "processing_actions": [
            {
              "action": "find_resource",
              "configuration": {
                "resource_name": "account",
                "resource_attribute": "code",
                "index": "AccountCode"
              }
            }
          ]
        }
      ]
    }
  }
}
'
{
  "error": "<string>"
}

​
Request Structure

{
  "data": {
    "type": "import_configurations",
    "attributes": {
      "name": "Acme Orders CSV (v2)",
      "failure_strategy": "abort"
    }
  }
}

​
Key Fields

FieldRequiredDescription
nameNoConfiguration name
parserNoFile format parser
failure_strategyNoskip_resource or abort
settings / pre_processors / automatic_processing_flows / manual_processing_flowsNoReplace the corresponding configuration sections

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 import configuration to update

Body

application/json
​
data
object
required

Response

Operation completed successfully with no content to return