GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Overview

The node provides an interface to manage identities within a messaging gateway platform. Specifically, the "Remove-alias" operation allows users to remove a platform alias from an existing identity. This is useful when an alias (a linked platform user account) is no longer relevant or should be disassociated from the identity.

Common scenarios include:

  • Cleaning up outdated or incorrect platform aliases linked to an identity.
  • Managing user accounts that have multiple platform presences and need alias adjustments.
  • Maintaining accurate identity records by removing obsolete aliases.

For example, if an identity represents a user aggregated across multiple platforms (e.g., Telegram, Discord), and one of the platform accounts is no longer valid or should be removed, this operation removes that specific alias from the identity.

Properties

Name Meaning
Identity ID The unique identifier of the identity from which the alias will be removed.
Alias ID to remove The unique identifier of the alias to be removed from the identity.
Project The project identifier under which the identity exists and the operation is performed.

Output

The output JSON contains the response from the API after attempting to remove the alias. Typically, this will confirm the success of the deletion or provide error details if the removal failed.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authentication with the messaging gateway's API.
  • The node makes HTTP DELETE requests to the endpoint structured as:
    /api/v1/projects/{project}/identities/{id}/aliases/{aliasId}
    where {project}, {id}, and {aliasId} are replaced by the respective input parameters.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Identity ID or Alias ID will result in errors.
    • Insufficient permissions or missing API credentials can cause authorization failures.
    • Network connectivity issues may prevent successful API calls.

  • Error messages:

    • 404 Not Found: The specified identity or alias does not exist. Verify the IDs.
    • 401 Unauthorized: Authentication failed due to missing or invalid API key. Check credentials.
    • 400 Bad Request: Input parameters might be malformed or missing. Ensure all required fields are provided.

  • Resolution tips:

    • Double-check the Identity ID and Alias ID values.
    • Confirm the API key credential is correctly configured and has necessary permissions.
    • Review network settings and API endpoint accessibility.

Links and References

Discussion