Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
This node operation "Add-alias" under the "Identities" resource allows you to add a new platform alias to an existing identity within a project. An identity represents a user or entity that can have multiple aliases across different messaging platforms. Adding an alias links a new platform-specific user account to the existing identity, enabling unified management and interaction across platforms.
Common scenarios for this node include:
- Linking a user's Telegram, Discord, or WhatsApp accounts to a single identity.
- Expanding an identity's presence by associating additional platform accounts.
- Managing multi-platform user identities in messaging gateway applications.
For example, if you have an identity representing a customer, and they create a new account on a different messaging platform, you can use this operation to add that platform alias to their existing identity record.
Properties
| Name | Meaning |
|---|---|
Identity ID (id) |
The unique identifier of the existing identity to which the alias will be added. |
Platform configuration ID (platformId) |
The identifier of the platform configuration (e.g., Telegram, Discord) for the alias. |
Provider-specific user ID (providerUserId) |
The user ID specific to the platform provider for the alias being added. |
Display name on the platform (providerUserDisplay) |
Optional display name of the user on the platform. |
Project (project) |
The project identifier within which the identity exists and the alias is added. |
Output
The output JSON contains the response from the API after adding the alias to the identity. This typically includes details of the updated identity with the newly added alias information. The exact structure depends on the API response but generally confirms successful addition and provides the alias and identity metadata.
No binary data output is involved in this operation.
Dependencies
- Requires an active connection to the messaging gateway API via an API key credential.
- The node must be configured with the correct base URL and authentication credentials for the API.
- The
projectparameter must correspond to an existing project in the system. - The identity specified by
idmust already exist in the project.
Troubleshooting
- Invalid Identity ID: If the provided identity ID does not exist, the API will return an error indicating the identity was not found. Verify the ID is correct.
- Invalid Platform ID or User ID: Providing incorrect platform configuration ID or provider user ID may cause failure to add the alias. Ensure these values are valid and correspond to existing platform configurations.
- Missing Required Fields: All required fields (
id,platformId,providerUserId,project) must be provided; otherwise, the request will fail validation. - API Authentication Errors: Ensure the API key credential is valid and has permissions to modify identities in the specified project.
- Project Not Found: The specified project must exist; otherwise, the operation will fail.
Links and References
- Messaging Gateway API Documentation (hypothetical link)
- n8n Documentation on HTTP Request Node (for understanding how API requests are made)
- Managing Identities and Aliases (conceptual overview)
This summary is based on static analysis of the node's properties and routing configuration for the "Add-alias" operation under the "Identities" resource.