API Updates: Install New Updates
Link: https://support.brilliantdirectories.com/support/solutions/articles/12000109034
The Install New Updates module on the admin dashboard lists one-time platform installers that have pending steps for your specific website. Click the green Check For Updates button to refresh the list — an installer only appears when your site actually has something left to install, and it disappears from the list once its steps are complete.
What API Updates Does
This installer makes one small maintenance change to the database table your site uses to log API activity. It updates the column that stores each API call’s response so it matches the platform’s current definition, which can hold long response text and the full range of Unicode characters. Specifically, it changes the api_response column in the bd_api_logs table to the TEXT data type with utf8mb4 encoding. No data is deleted, no other tables are touched, and nothing on your live website changes.
Why It Appears
It appears when your site’s database has the bd_api_logs table but its api_response column still uses a data type other than TEXT, which means the table was created under an older definition. This is a legacy condition: sites whose API log table was created after the current definition shipped already have the correct column type. If your site does not have the bd_api_logs table at all, there is nothing to update and the installer stays hidden.
Why It Matters
The bd_api_logs table records the responses returned by API calls made to your site, which is useful when you or a developer are troubleshooting an API integration. A column with an older, more limited data type can cut off long responses or mishandle special characters, leaving incomplete log entries. After this update the column can store the full response text, including 4-byte Unicode characters such as emoji. This is a minor consistency fix: it improves the reliability of your API logs and has no effect on how your website looks or behaves for visitors.
How to Run It
- From the admin dashboard, find the Install New Updates module and click Check For Updates.
- If your site has pending steps, API Updates appears in the list. Click Install.
- After it completes, click Check For Updates again — the entry disappears once all steps are done.
If API Updates does not appear in the list, your website is already up to date — the module only shows installers with pending steps, so there is nothing to do.
After Running
A success message confirms the column was changed. There is nothing visible to verify on your website, because the change affects only how one internal logging column stores data. Existing log entries remain in place, and if you use the API, new log entries will record response text under the updated column definition. The change is a safe, one-time adjustment to a column definition and does not remove any data.
