AppSheet icon

AppSheet

Interact with the AppSheet API to add, read, update, delete records, or invoke a custom action on table records.

Actions7

Invoke Action

AI-generated

Summary

Invokes a specified AppSheet action on records.

Inputs

  • region — AppSheet region domain to use in the API URL (default: www.appsheet.com).
  • tableName (required) — Name of the AppSheet table (URL-encoded if needed).
  • actionName — Name of the action to invoke, e.g., "IncrementCountAction".
  • invokeRecords — Record(s) to which the action is applied; must contain key field values.
  • locale — Locale for formatting dates and numbers (default: en-US).
  • location — Geographical coordinates for the request (default: 47.623098, -122.330184).
  • timezone — Timezone for date/time formatting (default: Pacific Standard Time).
  • actionProperties — Optional JSON object of additional properties for the action.
  • runAsUserEmail — User email to run the action as; empty means runs as the app owner.
  • userSettings — User settings to apply; leave empty for none.

Output shape

Array of objects representing the result of the invoked action (e.g., created/updated records, existence info).

The shape varies by action; may contain records, meta information, or simple success/failure. No pagination; optional fields may be omitted.

Examples

Example 1: Increment a counter on a specific employee record

region=www.appsheet.com, tableName=Employees, actionName=IncrementCountAction, invokeRecords=[{key:"Id",value:"123"}], actionProperties='{"increment":1}'

Example 2: Find if a Customer record exists based on email

region=eu.appsheet.com, tableName=Customers, actionName=FindRecordAction, selector=FILTER(Customers, [Email]="john@example.com"), invokeRecords=[{key:"Email",value:"john@example.com"}]

Example 3: Upsert multiple order rows with custom properties

region=www.appsheet.com, tableName=Orders, actionName=UpsertRecords, upsertRecords=[{record:[{key:"Field",value:"Status"},{key:"Value",value:"Processing"}]}], actionProperties='{"status":"Processing"}'

Links

Discussion