Data Source Update

Updates an existing data source.

Authorization

AuthorizationBearer <token>

JWT token to authenticate the request.

In: header

X-Api-Key<token>

API key, sent as a request header.

In: header

Path Parameters

dataSourceGuid*string

GUID of the data source to update.

Formatuuid

Request Body

application/json

The DataSourceModel payload to update. Server-managed fields (ids, timestamps, links, isDeleted) are ignored.

TypeScript Definitions

Use the request body type in TypeScript.

A stored data source. On create only name, description, urn, query, variables and loadMethod are supplied; everything else here is server-assigned.

name?string

Human-readable name of the data source.

description?|

Free-text description of what this data source provides.

urn?|

Where the data lives. Its meaning depends on loadMethod: a Storage key, a OneDrive file id or a Google Drive file id when loadMethod is Storage, OneDrive or GoogleDrive; the URL of the external API to call when loadMethod is GraphQL. In the GraphQL case the target does not have to be a true GraphQL endpoint — a plain REST endpoint works too, and is called with a PUT request instead of a GraphQL query.

A Storage key points at a file uploaded through documents-data-upload, and those files are removed once a generate request consumes them or after 24 hours, whichever comes first. A data source therefore does not hold a permanent copy of the data: upload a fresh file and update the data source's urn for each generation run.

query?|

GraphQL request body, as a JSON-serialized string, for example "{\"query\":\"{...}\"}". Read only when loadMethod is GraphQL and ignored for every other load method. Optional even for GraphQL. Stored exactly as supplied — the syntax is not validated here, only rejected when blank or whitespace.

variables?|

Values injected into the data before merging, as a JSON-serialized string. Read alongside query when loadMethod is GraphQL, where they supply values for the variables the query references. Stored exactly as supplied — the content is not validated here, only rejected when blank or whitespace.

loadMethod?string

How the data at urn is retrieved. Storage, OneDrive and GoogleDrive treat urn as a static file location and use its contents as-is; for a drive, the file must be accessible to the account tied to the request's auth token. GraphQL treats urn as the URL of an external API to call, combining it with query and variables to build the request and transform the result into the data the template consumes.

Value in

"Storage"
"OneDrive"
"GoogleDrive"
"GraphQL"

Response Body

`application/json`

curl -X PUT "https://example.com/documents/datasource/3f2504e0-4f89-41d3-9a0c-0305e82c3301/update" \  -H "Content-Type: application/json" \  -d '{    "name": "Q3 Sales Report Data",    "description": "Account records used for quarterly reports.",    "urn": "a4f8c9d2-6b3e-4f1a-9c7d-2e5b8a1f4d6c",    "loadMethod": "Storage"  }'

{  "result": {    "data": {      "dataSourceGuid": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",      "subscriptionGuid": "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d",      "ownerGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d",      "lastModifiedUserGuid": "1a2b3c4d-5e6f-4a1b-8c2d-3e4f5a6b7c8d",      "name": "Q3 Sales Report Data",      "description": "Account records used for quarterly reports.",      "urn": "a4f8c9d2-6b3e-4f1a-9c7d-2e5b8a1f4d6c",      "query": "",      "variables": "",      "loadMethod": "Storage",      "createdDate": "2026-07-14T09:30:00.000Z",      "lastModifiedDate": "2026-07-14T09:30:00.000Z",      "isDeleted": false    },    "statusCode": 200,    "message": "OK"  },  "origin": "PUT https://api.doctavian.com/v1/documents/datasource/{dataSourceGuid}/update",  "dateTime": "2026-07-14T09:30:00.000Z",  "operationId": "5d13f110feef548ef7b93153ffa9cf92",  "userId": "7c44abb9-109e-4d32-8885-69490933300f"}

{  "userId": "914cc5b1-fcc0-4f3e-be31-5a8716911f4d",  "error": {    "statusCode": 400,    "message": "Name is required.",    "innerErrors": [      {        "code": "DATA_NAME_REQUIRED",        "message": "Name is required.",        "userMessage": "Name is required."      }    ]  },  "origin": "PUT https://api.doctavian.com/v1/documents/datasource/{dataSourceGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "e7b18efc5666ff4e59f604c08186de1c"}

{  "error": {    "statusCode": 401,    "message": "The request could not be authenticated.",    "innerErrors": [      {        "code": "UNAUTHORIZED",        "message": "The request could not be authenticated.",        "userMessage": "Your session has expired or is invalid. Please sign in again."      }    ]  },  "origin": "PUT https://api.doctavian.com/v1/documents/datasource/{dataSourceGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "130bc2d3fc1821d95515e49f22b58682",  "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}

{  "error": {    "statusCode": 404,    "message": "The requested resource was not found.",    "innerErrors": [      {        "code": "NOT_FOUND_BY_ID",        "message": "The requested resource was not found.",        "userMessage": "We couldn't find that resource. Check the id and try again."      }    ]  },  "origin": "PUT https://api.doctavian.com/v1/documents/datasource/{dataSourceGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "46b490855ba04c1e2ba19e13e68e18fa",  "userId": "748b2a39-7231-4b49-832b-9ef189074a21"}

{  "userId": "4745612a-9166-4c5c-8c95-a5a6d9c06a0f",  "error": {    "statusCode": 500,    "message": "An unexpected error occurred.",    "innerErrors": [      {        "code": "GET_DATA_SOURCE_ERROR",        "message": "An unexpected error occurred.",        "userMessage": "An unexpected error occurred."      }    ]  },  "origin": "PUT https://api.doctavian.com/v1/documents/datasource/{dataSourceGuid}/update",  "dateTime": "2026-01-02T12:34:56.000Z",  "operationId": "1665e9f991efe8fb039577a72d589b71"}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`