Class: SmartInvites

SmartInvites

Methods

(static) create(params) → {Promise.<SmartInvite>}

Create a new Smart Invite.
Parameters:
Name Type Description
params Object Invite parameters.
Properties
Name Type Description
channel string The invite channel the link will be used on, e.g whatsapp. Defaults to web if unspecified.
custom_data Object.<string, string> Custom data in key/value pairs attached to this invite. These values will be present in the referral data. See Referral Data Reference for reserved keys.
Source:
Returns:
- A Promise of a SmartInvite object.
Type
Promise.<SmartInvite>

(static) createInvite()

Deprecated. Use create.
Deprecated:
  • Yes
Source:

Type Definitions

SmartInvite

Type:
  • Object
Properties:
Name Type Description
url string URL of the Smart Invite.
channel string The channel the link will be shared on, e.g whatsapp.
custom_data Object.<string, string> Custom data attached to this link.
Source: