CHchift
Syncs

A consumer's setup of an agentic sync

Changed on

What the consumer can choose, what runs, which mapping tables and questions that needs, and what still stops the sync from being enabled. Capabilities your account does not offer are absent.

get/consumers/{consumer_id}/syncs/{syncid}/capabilities

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required

Query parameters

languagestring nullable

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

flowidstring uuid required

The sync's one flow: what enable, disable, the answers' PATCH and the executions take as {flowid}.

enabledboolean required

Whether the sync is enabled for this consumer.

latest_preview_idstring uuid nullable required

The most recent preview of this consumer sync, if any.

Example response

{
  "capabilities": [
    {
      "key": "spend_to_accounting.SupplierInvoices",
      "default_mode": "spend_to_accounting.SupplierInvoices.AsInvoice",
      "modes": [
        {
          "key": "spend_to_accounting.SupplierInvoices.AsInvoice",
          "requires_modes": [
            {
              "capability": "spend_to_accounting.SupplierInvoices",
              "mode": "spend_to_accounting.SupplierInvoices.AsInvoice"
            }
          ]
        }
      ]
    }
  ],
  "tables": [
    {
      "key": "spend_to_accounting.PurchaseVatCodes"
    }
  ],
  "questions": [
    {
      "key": "spend_to_accounting.ExpensesSince"
    }
  ],
  "connections": [
    {
      "vertical": "accounting"
    }
  ]
}

Changes