Update a knowledge source

PATCH

https://example.ada.support/api/v2/knowledge/sources/:id

PATCH

/api/v2/knowledge/sources/:id

import requests
url = "https://example.ada.support/api/v2/knowledge/sources/id"
payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())

{
  "id": "5df263b7db5a7e6ea03fae9b",
  "name": "Ada Knowledge Base",
  "availability_rules": {
    "match": "all",
    "conditions": [
      {
        "variable": {
          "id": "5df263b7db5a7e6ea03fae9b"
        },
        "operator": "equals",
        "value": "en"
      }
    ]
  },
  "external_id": "external_id_1",
  "metadata": {
    "example_key1": "example_string_value",
    "example_key2": true,
    "example_key3": 123
  },
  "created": "2020-09-20T00:00:00+00:00",
  "updated": "2020-09-20T00:00:00+00:00",
  "last_sync": "2020-09-20T00:00:00+00:00",
  "status": "deleting",
  "sync_schedule": {
    "hours": [
      7,
      19
    ],
    "days": [
      1,
      2,
      3,
      4,
      5
    ],
    "timezone": "America/Toronto"
  }
}

Update a knowledge source

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

id of the knowledge source to update

Request

This endpoint expects an object.

external_idstring or nullOptional1-160 characters

A unique identifier for the knowledge source

namestringOptional>=1 character

The name of the knowledge source

metadataobject or nullOptional

A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.

sync_frequencyenumOptional

The legacy sync frequency of a website import. daily syncs every day. weekly keeps the source’s days when it has 1 to 6 of them, or else syncs on one weekday. Both keep the hours and the timezone the source already has; a source without hours gets 23:00 UTC. never syncs only on request and discards the hours and timezone. sync_schedule wins when both are sent.

Allowed values:

sync_scheduleobjectOptional

When the website import syncs. Replaces the whole schedule: hours, days and timezone. Wins over sync_frequency when both are sent. Website imports only.

availability_rulesobject or nullOptional

Replace the source’s availability-rule template. Articles created after the change get the new template. Existing articles keep their own rules. Send null to remove the template. Omit to leave it unchanged.

Response

Knowledge source updated

idstring

A unique identifier for the knowledge source

namestring>=1 character

The name of the knowledge source

availability_rulesobject or null

The source’s availability-rule template. Each new article created under the source whose request omits availability_rules gets it. null when the source has none.

external_idstring or nullOptional

An external identifier for the knowledge source

metadataobject or nullOptional

A dictionary of arbitrary key,value pairs. This data is not used by Ada, but can be used by the client to store additional information about the knowledge source.

createdstringOptionalformat: "date-time"

The date the knowledge source was created

updatedstringOptionalformat: "date-time"

The date the knowledge source was last updated

last_syncstringOptionalformat: "date-time"

The date the knowledge source was last synchronized

statusenumOptional

Deletion lifecycle status of the knowledge source: deleting while an asynchronous deletion is in progress, delete_failed if the deletion failed. null when no deletion is in progress.

Allowed values:

sync_scheduleobject or nullOptional

When the website import syncs. null on a source that is not a website import.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error