Actions51
- Platforms Actions
- Projects Actions
- Webhooks Actions
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
Overview
The "Platforms: Update" operation in this node allows users to update the configuration of an existing platform integration within a specified project. This includes modifying the platform's friendly name, description, credentials, activation status, and test mode setting. It is useful for maintaining or adjusting platform integrations without needing to recreate them from scratch.
Typical use cases include:
- Changing the display name or description of a platform integration to reflect updated branding or purpose.
- Updating authentication credentials or API keys securely stored as JSON objects.
- Enabling or disabling a platform integration temporarily without deleting it.
- Switching the platform into or out of test mode for development or troubleshooting.
For example, if you have integrated a Telegram platform and need to update its API token or rename it for clarity, this operation facilitates those changes seamlessly.
Properties
| Name | Meaning |
|---|---|
| Updated friendly name (name) | New display name for the platform integration. Optional. |
| Updated description (description) | New descriptive text about the platform integration. Optional. |
| Updated credentials (credentials) | JSON object containing updated authentication credentials or configuration details. Optional. |
| Enable/disable platform (isActive) | Boolean flag to activate (true) or deactivate (false) the platform integration. Optional. |
| Enable/disable test mode (testMode) | Boolean flag to enable (true) or disable (false) test mode on the platform. Optional. |
| Project (project) | Identifier of the project where the platform integration exists. Required. |
| Id (id) | Unique identifier of the platform integration to update. Required. |
Output
The output of this operation is the JSON response returned by the platform management API after updating the platform configuration. This typically includes the updated platform details such as its ID, name, description, credentials (usually masked or omitted), status flags, and timestamps.
No binary data output is involved.
Dependencies
- Requires an API key credential for authenticating requests to the GateKit API.
- The node must be configured with the base URL of the API service.
- The user must have appropriate permissions to update platform configurations within the specified project.
Troubleshooting
- Missing required fields: Ensure that both
projectandidare provided; these are mandatory to identify which platform to update. - Invalid credentials format: When updating credentials, ensure the JSON object is correctly formatted and contains all necessary fields expected by the platform.
- Permission errors: If the API returns authorization errors, verify that the API key has sufficient rights for the project and platform.
- Platform not found: Confirm that the platform ID corresponds to an existing platform in the given project.
- Network or API errors: Check connectivity and API endpoint correctness; also verify that the base URL and headers are properly set.
Links and References
- GateKit API Documentation (generic reference to the API used)
- n8n documentation on HTTP Request Node for understanding how routing and request options work in custom nodes