← Grist

Add Or Update Records with Grist API

Pipedream makes it easy to connect APIs for Grist and 2,000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Add Or Update Records with the Grist API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Add Or Update Records with the Grist API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Add Or Update Records action
    1. Connect your Grist account
    2. Configure Document ID
    3. Select a Table ID
    4. Optional- Configure Do Not Parse
    5. Optional- Select a On Many
    6. Optional- Configure No Add
    7. Optional- Configure No Update
    8. Configure Data Records
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Add Or Update Records with Grist API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Grist
 
Try it
Add Or Update Records with Grist API on New Submission from Typeform API
Typeform + Grist
 
Try it
Add Or Update Records with Grist API on New Submission (Instant) from Jotform API
Jotform + Grist
 
Try it
Add Or Update Records with Grist API on New Scheduled Tasks from Pipedream API
Pipedream + Grist
 
Try it
Add Or Update Records with Grist API on npm Download Counts from npm API
npm + Grist
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Add Or Update Records on Grist
Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)
Version:0.0.1
Key:grist-add-update-records

Code

import app from "../../grist.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
GristappappThis component uses the Grist app.
Document IDdocIdstring

The ID of the Grist document to operate on. You can find this in the Settings menu of the document.

Table IDtableIdstringSelect a value from the drop down menu.
Do Not ParsenoParseboolean

Set to true to prohibit parsing strings according to the column type.

On ManyonManystringSelect a value from the drop down menu:{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }
No AddnoAddboolean

Set to true to prohibit adding records.

No UpdatenoUpdateboolean

Set to true to prohibit updating records.

Data Recordsrecordsstring[]

The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. [ { "fields": { "pet": "cat", "popularity": 67 } } ]. Instead of an id, a require object is provided, with the same structure as fields. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in require. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in require and fields, with fields taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. [ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]

Authentication

Grist uses API keys for authentication. When you connect your Grist account, Pipedream securely stores the keys so you can easily authenticate to Grist APIs in both code and no-code steps.

To retrieve your API key,

  • Navigate to your Girst account and sign in
  • Go to “Profile Settings” > “API”

About Grist

The evolution of spreadsheets.

More Ways to Use Grist

Triggers

New or Updated Record (Instant) from the Grist API

Emit new event once a record is updated or newly created in Grist. See the documentation

 
Try it
New Record (Instant) from the Grist API

Emit new event when a record is just created. See the documentation

 
Try it

Actions

Add Records with the Grist API

Appends new records to a chosen table in Grist. See the documentation

 
Try it
Find Records with the Grist API

Searches for records in a specified table. See the documentation

 
Try it

Explore Other Apps

1
-
24
of
2,000+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce (REST API)
Salesforce (REST API)
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify Developer App
Shopify Developer App
Shopify is a user-friendly e-commerce platform that helps small businesses build an online store and sell online through one streamlined dashboard.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.