Trigger Events

You can trigger events from client to SuprSend using track method. This can be used to trigger event-based workflows.

const resp = await suprSendClient.track(event: string, properties?: Dictionary)

Returns: Promise<ApiResponse>

Update User Profile

Returns: Promise<ApiResponse>

Update User channels

Set user channel related information using following methods. Its recommended to use SuprSend’s Backend SDK’s to set user channels instead of Client SDK’s.

await suprSendClient.user.addEmail(email: string)
await suprSendClient.user.removeEmail(email: string)

// mobile should be as per E.164 standard: https://www.twilio.com/docs/glossary/what-e164
await suprSendClient.user.addSms(mobile: string)
await suprSendClient.user.removeSms(mobile: string)

// mobile should be as per E.164 standard
await suprSendClient.user.addWhatsapp(mobile: string)
await suprSendClient.user.removeWhatsapp(mobile: string)

Update User properties

This is the list of available user update methods:

Keys starting with ss_ or $ will be ignored.


Was this page helpful?