The Orgzit Web API is an interface for querying information from and enacting change in an Orgzit workspace. You can use the API not only to update records but also to fetch records and create records in Orgzit.
Updating records through API is a three-step process:
- Accessing the API Key
- Making a Record Update Request
- Making the Requests to Update the Record
Below is a snapshot of a Task Tracker workspace. Let’s see the steps to update the Status data field of a record in the Task Tracker table by API Integration.
Here, we will change the status of record ID 8 from 00-New to 02-On Hold.
1. Accessing the API Key
To access your API Key, follow the steps mentioned in the support article here.
2. Making a Record Update Request
Once you retrieve the API key from your account, you can start making requests with the API.
- You will need to pass the key to the API in the header of your requests. Paste the key you copied in the Authorization Header.
- Set the Request Method to PUT.
- The Request URL has the following format:
where the account_name is the name of your Orgzit account and the record_id is the ID of the record you have to update.
To find the record ID of a record, open the expanded view of the record and copy its permalink.
Within the permalink
, the ID right after /#r/ is the record ID.
- Set the Request Payload in the JSON format.
"status": "02-On Hold"
Here, jhtxltf37l is the dataform_id. You can find the dataform_id in the URL just before your dataform/table name.
Here, task-tracker is the dataform/table, and jhtxltf37l is the dataform_id.
Dataform refers to the Table that you are integrating with. Here, dataform contains the resource URL of the format /api/1/dataform/dataform_id/
Here, jhtxltf37l is the dataform_id.
Within fields, you can pass the field names and their respective values that you want to update.
To get the Field Names, move to the Table Manage Page and go to the Table Fields section. The Normalized Name will be the field name that you have to pass to create a record.
3. Making the Requests to Update the Record
Once you set all values for the record that you are about to update, send your API request.
You can now check your workspace dataform/table, you will find that your record has been updated with the values passed by you.