Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
The "Platforms: Update" operation allows users to modify the configuration of an existing platform integration within a specified project. This includes updating the platform's friendly name, description, credentials, activation status, and test mode setting. It is useful for maintaining or adjusting platform settings without needing to recreate the integration from scratch.
Typical use cases include:
- Changing the display name or description to better reflect the platform's purpose.
- Updating authentication credentials when they expire or need rotation.
- Enabling or disabling the platform temporarily.
- Switching the platform into or out of test mode for development or troubleshooting.
For example, if you have integrated a Telegram bot and want 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 instance. Optional; leave empty to keep unchanged. |
| Updated description (description) | New descriptive text about the platform instance. Optional; leave empty to keep unchanged. |
| Updated credentials (credentials) | JSON object containing updated authentication credentials specific to the platform. 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 that owns the platform configuration. Required. |
| Id (id) | Unique identifier of the platform configuration to update. Required. |
Output
The node outputs the response from the platform update API call in the json field of the output data. This typically contains the updated platform configuration details as returned by the backend service, including any changed properties and metadata.
No binary data output is involved in this operation.
Dependencies
- Requires an active API key credential with permissions to manage platform configurations.
- The node communicates with a REST API endpoint at
/api/v1/projects/{project}/platforms/{id}using the PATCH HTTP method. - Proper project identification and platform ID must be provided.
- The user must ensure that the credentials JSON structure matches the requirements of the specific platform being updated.
Troubleshooting
- Invalid or missing platform ID: Ensure the
idproperty is correctly set to the platform configuration's unique identifier. - Insufficient permissions: Verify that the API key used has rights to update platform configurations within the specified project.
- Malformed credentials JSON: When updating credentials, ensure the JSON object is valid and conforms to the expected schema for the platform.
- API errors related to platform state: Some platforms may reject updates if the platform is in an inconsistent state; check platform logs or error messages for details.
- Network or connectivity issues: Confirm that the base URL and API endpoint are reachable and that authentication headers are correctly configured.
Links and References
- MsgCore API Documentation (replace with actual URL)
- Platform-specific credential requirements can be viewed via the "supported platforms" listing in the API.
- n8n documentation on HTTP Request Node for understanding how routing and requests work.