Hey dev community,
We recently made a bunch of improvements to our API, SDK, and documentation! Check out the list of changes below.
Additions to our Documentation:
Surfacing Field IDs
Did you know that field ids and field names are interchangeable? Using only field names can be problematic when there are unexpected field name changes. To make this more prominent, we just added the field id in the
fields section of the API docs along with a blurb explaining that field names and field ids are interchangeable. We hope this saves you the headache of dealing with unexpected field name changes in the future.
Documenting Synced Table Behavior
Synced tables are one of the most powerful tools in Airtable but are less editable than regular tables. These restrictions, such as being unable to add new records, are also present in the API.
To make these restrictions clearer we’ve updated the api docs so that
- Fields in synced tables that cannot be edited are appropriately marked in the
fieldssection of the docs
delete recordsections of the docs inform you if they are unavailable because the table is a synced table
update recordsection of the docs says that destructive updates will fail for synced tables and that regular updates will fail if you include a synced field.
API & SDK Improvements
Field IDs & Table IDs are now in REST API requests
IDs and names can be used interchangeably in API requests. Now you have the option to provide field and table ids in your API requests, and receive ids instead of names in the response. That way, you can avoid modifications to your API request even if the name of the field or table changes.
Workspace ID in blocks SDK
You can access the ID of the workspace that your base is in the blocks SDK by calling on the
base.workspaceId property. Check out the blocks sdk documentation for more comprehensive syntax.
Field.updateNameAsync method to SDK and Scripting
updateNameAsync method to update any field name from the SDK or a scripting block. Naming things is hard, hopefully this makes it a lot easier. Check out the APPs API documentation and Scripting API documentation to learn more about using this method.
Feel free to drop any questions or comments below!