Actions52
- ApiKeys Actions
- Auth Actions
- Identities Actions
- Members Actions
- Messages Actions
- Platform Logs Actions
- Platforms Actions
- Projects Actions
- Webhooks Actions
Overview
The node provides an interface to update identity metadata within a messaging platform project. It allows users to modify details such as the display name, email address, and JSON metadata associated with a specific identity. This operation is useful for maintaining accurate and up-to-date user information across integrated messaging platforms.
Typical use cases include:
- Updating a user's display name or contact email after profile changes.
- Adding or modifying custom metadata related to the identity for enhanced personalization or integration purposes.
- Managing identities programmatically in bulk workflows where user data needs periodic updates.
Properties
| Name | Meaning |
|---|---|
| Identity ID | The unique identifier of the identity to update (required). |
| Updated display name | New display name to assign to the identity (optional). |
| Updated email address | New email address to assign to the identity (optional). |
| Updated JSON metadata | JSON string containing updated metadata for the identity (optional). |
| Project | Identifier of the project under which the identity exists (required). |
| Id | Alias for Identity ID parameter (required). |
Output
The output of this node will be the JSON response from the API representing the updated identity object. This typically includes the updated fields such as display name, email, metadata, and other identity-related information as returned by the service.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential configured in n8n to authenticate requests against the messaging platform's API.
- The node sends a PATCH HTTP request to the endpoint
/api/v1/projects/{project}/identities/{id}to perform the update. - The
projectparameter must correspond to an existing project identifier in the platform.
Troubleshooting
- Missing required parameters: Ensure that both
Identity IDandProjectare provided; otherwise, the API call will fail. - Invalid JSON metadata: If the
metadatafield is provided, it must be a valid JSON string; invalid JSON will cause errors. - Permission issues: The API key used must have sufficient permissions to update identities within the specified project.
- Identity not found: If the given
Identity IDdoes not exist in the project, the API will return an error indicating the resource was not found. - Network or authentication errors: Verify API URL configuration and credentials if requests fail due to connectivity or authorization problems.
Links and References
- MsgCore API Documentation (general reference for endpoints and payloads)
- n8n Documentation on HTTP Request Node (for understanding how API calls are made)
This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.