MsgCoreInstall

Summary

Update identity metadata (display name, email, JSON metadata) for a specific identity via PATCH request to /api/v1/projects/:project/identities/:id.

Inputs

• id (required) — Identity ID
• project (required) — Project identifier to operate on (default: 'default')
• additionalFields — Collection of fields to update: displayName, email, metadata. Each is an optional string routed to the request body.

Output shape

Updated identity metadata as returned by the MsgCore API. Exact shape not explicitly declared; described by the fields updated via additionalFields.

If neither properties nor source specify a return shape, describe what is declared. Do not guess return data.

Examples

Example 1: Update an identity's display name and email

Set 'id' to the target identity's ID, 'project' to the project key, and add 'displayName' and 'email' under 'additionalFields'.

Example 2: Throttle updates across many identities

Configure 'requestOptions' with 'batching' (batchSize, batchInterval) to split input items into throttled batches.