GateKit icon

GateKit

Universal messaging gateway - send messages across multiple platforms

Actions51

Overview

The "Update Identity" operation in the GateKit node allows you to modify metadata of an existing identity within a specified project. This includes updating the display name, email address, and JSON metadata associated with the identity. It is useful for maintaining accurate and up-to-date information about users or entities represented as identities in your messaging gateway system.

Typical use cases include:

  • Correcting or changing a user's display name or email.
  • Adding or modifying custom metadata stored as JSON for richer identity profiles.
  • Keeping identity records synchronized with external systems or user inputs.

For example, if a user changes their email address or updates their profile information, this operation can be used to reflect those changes in the GateKit platform.

Properties

Name Meaning
Identity ID The unique identifier of the identity to update (required).
Updated display name New display name for the identity (optional).
Updated email address New email address for the identity (optional).
Updated JSON metadata New JSON-formatted metadata string to associate with the identity (optional).
Project Identifier of the project where the identity exists; specifies the scope of the update (required).

Output

The output of this operation will be the JSON response from the API after updating the identity. This typically includes the updated identity object with its current properties such as id, displayName, email, metadata, and possibly other system-generated fields.

No binary data output is involved in this operation.

Dependencies

  • Requires an active API key credential configured in n8n to authenticate requests to the GateKit API.
  • The node uses the base URL provided by the credential's API URL configuration.
  • The project identifier must correspond to an existing project in the GateKit system.

Troubleshooting

  • Missing or invalid Identity ID: Ensure that the Identity ID provided is correct and exists in the specified project.
  • Invalid JSON metadata: If providing metadata, ensure it is a valid JSON string; otherwise, the API may reject the request.
  • Permission errors: The API key used must have sufficient permissions to update identities in the target project.
  • Network or authentication issues: Verify that the API URL and credentials are correctly set up in n8n.

Common error messages might include:

  • 404 Not Found if the identity or project does not exist.
  • 400 Bad Request if input parameters are malformed.
  • 401 Unauthorized if the API key is missing or invalid.

Resolving these usually involves verifying input values, credentials, and project existence.

Links and References

Discussion