Workflows ReferenceType Definitions
WriteIdentityLinksWorkflowUtils
type WriteIdentityLinksWorkflowUtils = {
link: (options) => Promise<IdentityLinkWorkflowData>;
unlink: (options) => Promise<void>;
};Utilities for writing (creating and removing) identity links between users.
Properties
link()
link: (options) => Promise<IdentityLinkWorkflowData>;Establishes a formal relationship (link) between two user identities.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | CreateIdentityLinkOptions | Options for creating the link. See CreateIdentityLinkOptions. |
Returns
Promise<IdentityLinkWorkflowData>
A promise resolving to the created link data.
Example
utils.identity.link({
source: { identifier: 'anon_1234', userType: 'anonymous' },
target: { identifier: 'member_1234', userType: 'authenticated' },
type: 'conversion',
dataSharing: 'none',
metadata: { 'UTM Campaign': 'November launch' },
})unlink()
unlink: (options) => Promise<void>;Removes an existing link between two user identities.
Parameters
| Parameter | Type | Description |
|---|---|---|
options | UnlinkIdentityOptions | Options for unlinking. See UnlinkIdentityOptions. |
Returns
Promise<void>
A promise that resolves when the link is removed.
Example
await utils.identity.unlink({
id: 'link_5678',
source: { identifier: 'anon_1234', userType: 'anonymous' },
target: { identifier: 'member_1234', userType: 'authenticated' },
})