CHchift
Syncs

Choose which capabilities your consumers are offered

Changed on

Turns capabilities on or off for all your consumers and sets the mode preselected where a consumer can choose. A capability that is off is absent for your consumers and stops running for them; turned on again, it runs again for the consumers who had selected it. Selections, mapping values and answers are never deleted. cron sets when the sync runs for every consumer that enabled it; it can always be started by hand.

put/syncs/{syncid}/capabilities

Request

Path parameters

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.

Request body

offeredobject

Capability key -> offered. A capability left out keeps its value.

default_modesobject nullable

Capability key -> mode key. Replaces every default mode when given; leave it out to keep them.

cronstring nullable required

When the sync runs for each consumer that enabled it, as a cron expression; it can always be started by hand. Null: only by hand.

Example request

{
  "offered": {
    "spend_to_accounting.Payments": false
  },
  "cron": "0 * * * *"
}

Response

Successful Response

cronstring nullable required

When the sync runs for each consumer that enabled it, as a cron expression. Null: it runs only when started by hand.

Example response

{
  "capabilities": [
    {
      "key": "spend_to_accounting.SupplierInvoices",
      "title": "Supplier invoices",
      "default_mode": "spend_to_accounting.SupplierInvoices.AsInvoice",
      "modes": [
        {
          "key": "spend_to_accounting.SupplierInvoices.AsInvoice"
        }
      ]
    }
  ],
  "cron": "0 * * * *"
}

Changes