COcodatio
Settings

Update all sync settings

Update sync settings for all data types.

post/profile/syncSettings

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/profile/syncSettings
  • Auth
    API key in header Authorization

Request body

clientIdstring uuid required

Unique identifier for your client in Codat.

overridesDefaultsboolean required

Set to True if you want to override default sync settings.

Example request

{
  "settings": [
    {
      "dataType": "invoices",
      "fetchOnFirstLink": true,
      "syncSchedule": 24,
      "syncOrder": 0,
      "syncFromUtc": "2020-01-01T12:00:00.000Z",
      "syncFromWindow": 24,
      "monthsToSync": 24,
      "isLocked": true
    }
  ]
}

Response

No Content

Changes

No recorded changes to this operation across all 72 revisions of this API.