Skip to main content
PATCH
/
core
/
companies
/
{company_id}
/
sync-config
Update Company Sync Config
curl --request PATCH \
  --url https://api.integrations.commenda.io/v4/core/companies/{company_id}/sync-config \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "configs": [
    {
      "interval": 2,
      "scope_access": {
        "READ": true,
        "CREATE": true,
        "UPDATE": true,
        "DELETE": true
      },
      "enabled": true,
      "sync_from": "2023-11-07T05:31:56Z"
    }
  ]
}
'
{
  "request_id": "ca61fc64-d8a6-40e1-a627-943fcc7014b3"
}

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Update per-model sync configuration for a company. Request body fields use snake_case; response objects on GET endpoints use camelCase.

​
Request Body

FieldTypeRequiredDescription
configsarrayYesNon-empty array of sync config entries.
Each item in configs:
FieldTypeRequiredDescription
data_modelenumYesV4 data model (e.g. ACCOUNT, INVOICE).
categoryenumYesIntegration category (ACCOUNTING, PAYMENTS, ECOMMERCE).
enabledbooleanYesWhether sync is enabled for this model.
frequencyenumYesDAILY, WEEKLY, MONTHLY, YEARLY, HOURLY, NEVER.
intervalintegerYesInterval multiplier (minimum 1).
scope_accessobjectYes{ READ, CREATE, UPDATE, DELETE } booleans.
sync_fromstringNoISO 8601 historical sync start date.

​
Response

Returns { request_id } on success.

Authorizations

​
api_key
string
header
required

Path Parameters

​
company_id
integer
required

Commenda company ID (rootfi_id).

Body

application/json
​
configs
WriteSyncConfigModel · object[]
required
Minimum array length: 1

Response

Sync configuration updated.

​
request_id
string
required