DatumForms.
Join the panel Sign in Create a survey

DATUMFORMS DOCUMENTATION

Refresh a connected spreadsheet (sheets.refresh)

Queue the existing Google Sheets export for group_id.

For developers

Updated 15 November 2026

On this page

Request

POST https://app.datumforms.com/api/developer-api

Operation: sheets.refresh Permissions: sheets:write.

Queue the existing Google Sheets export for group_id.

Send operation as a query parameter for GET, or a top-level JSON member for POST. Every POST also needs idempotency_key (8–100 permitted characters). Fields marked data belong inside the JSON data object.

Parameter Location Type Required Meaning
group_id top level integer Yes Group whose existing Sheets connection to refresh.

Response

Successful results contain success: true plus these operation fields. Fields returned by shared form and resource services retain their normal definitions.

Field Type or shape
group_id integer
refresh_pending boolean
revision integer
spreadsheet_id string

See schemas for answer cells, responses and collection details. Use IDs from your project: groups.list returns group IDs, surveys.get returns page/question IDs, and responses.list returns response IDs and revisions.

Examples

Set DATUMFORMS_API_KEY. Replace example IDs with IDs returned by the preceding reads. Replace docs-run-001 with your persisted job identity. Write examples perform the named operation; keep the exact request and identity unchanged when retrying. JavaScript and Python examples use the downloadable clients.

cURL

curl --fail-with-body 'https://app.datumforms.com/api/developer-api' \
  -H "Authorization: Bearer $DATUMFORMS_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{"operation":"sheets.refresh","group_id":123,"data":{},"idempotency_key":"docs-run-001:sheets-refresh"}'

JavaScript

import { request } from './client.mjs';
const result = await request("POST", {
  "operation": "sheets.refresh",
  "group_id": 123,
  "data": {},
  "idempotency_key": "docs-run-001:sheets-refresh"
});
console.log(JSON.stringify(result, null, 2));

Python

import json
from client import request
payload = json.loads('{"operation": "sheets.refresh", "group_id": 123, "data": {}, "idempotency_key": "docs-run-001:sheets-refresh"}')
result = request('POST', payload)
print(json.dumps(result, indent=2))

Pagination and errors

This operation does not use cursor pagination. For 400, check required values and types; for 401, check authentication; for 403, check permissions and project scope; for 404, check the resource ID. For 409, resolve the current revision or review conflict. Retry uncertain writes with the identical request and original key. See error recovery and the operation index.

Need help with this task? Contact DatumForms. Include the article URL and the step you reached.

Tracking preferences

Essential functions stay on. Choose whether to allow optional tracking on this website. You can change your choices in the footer at any time.

Read our privacy policy