URL

Use a URL in the following form to invoke the API.

POST https://api.appsheet.com/api/v1/apps/{appId}/tables/{tableName}/Action where

  • {appId} specifies the GUID of the AppSheet application.
  • {tableName} specifies the name of the table.

Application Access Key

You must include the API “ApplicationAccessKey” in the HTTP header of every API call. 

The “ApplicationAccessKey” is specified in the form:

ApplicationAccessKey=<applicationAccess Key>

For example:

ApplicationAccessKey=bA2SK-l5kzd-SdvFb-mqIe6-gAT8a-CXp3D-cjCYB-oiJ6U

The “ApplicationAccessKey” specified in the HTTP header is compared to the “Access Key” and “Alternate Access Key” values on the API pane. The HTTP request is rejected and logged to Audit History if the “ApplicationAccessKey” value does not match.

When invoking the API from an AppSheet WebHook you must specify the "ApplicationAccessKey" in the HTTP Header property and enclose the <applicationAccess Key> value in quotes. For example:

applicationAccessKey: "D2iXO-RjfVq-QvcLy-d9nil-WiLvt-BVAYy-R04LY-Xkt0q"

HTTP Body

The API HTTP Body specifies:

Actions

The name of the Action to perform. Select one of the following values:

  1. Add: Adds a new table record.
  2. Delete: Deletes an existing table record.
  3. Edit: Updates an existing table record.
  4. Action Name: Invokes an action.

Properties

The properties of the API request in JSON format. These properties are optional.

  • Locale: The Locale of the client making the request. For example “en-US” represents English, United States. If this value is not specified, Locale defaults to “en-US”.
  • Location: The latitude and longitude of the client making the request. This value is used for ChangeLocation fields. For example "47.623098, -122.330184" represents Seattle, Washington. If this value is not specified, the Location defaults to  "0.000000. 0.000000". 
  • Timezone: The timezone of the client making the request. For example "Pacific Standard Time" represents Pacific Standard Time in the United States and Canada. If this value is not specified, the Timezone defaults to "UTC".
  • RunAsUserEmail: The user email address of the person taking the action. The action is performed under the user id of the user email address you specify. If this value is not specified, the action is performed under the user id of the application owner.

Rows

The table’s field names and field values in JSON format.

  • You must specify field names and field value for all key fields for Actions "Delete", "Edit", and "Action". Special rules apply for Action "Add" as described here.
  • You may specify other field names and field value for Actions “Add” and “Update”.
  • The field values must match the data types in the table schema.

Did this answer your question?