createAccount( )

Creates a loyalty account for one of a site's contacts.

The createAccount() function returns a Promise that resolves to the new loyalty account when it is created.

To create a new loyalty account, the customer must first be a site contact with a contact ID. The site must also have an active loyalty program before loyalty accounts can be created.

Note: Only visitors with Manage Loyalty permissions can create a loyalty account.

Authentication

When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.

Permissions

Learn more about app permissions.

Method Declaration

Copy

function createAccount(contactId: string): Promise<CreateAccountResponse>;

Method Parameters

contactIdstringRequired

Contact ID for a Wix site contact. See the Contacts API to learn more.

Returns

Return Type:Promise<CreateAccountResponse>

Example shown:

Create a loyalty account for a site contact

JavaScript


import { accounts } from "@wix/loyalty";

// Sample contactId value: 'ff61204b-b19a-5cc8-823b-7eed8ae5fc28'

export async function myCreateAccountFunction(contactId) {
  try {
    const newLoyaltyAccount = await accounts.createAccount(contactId);

    const accountId = newLoyaltyAccount.account._id;

    console.log(
      "Success! The account ID for this new loyalty account is: ",
      accountId,
    );

    return newLoyaltyAccount;
  } catch (error) {
    console.error(error);
  }
}

/* Promise resolves to:
 * {
 *   "account": {
 *     "_id": "1e3f99cf-1e7f-4cba-8777-f081549f49cd",
 *     "contactId": "ff61204b-b19a-5cc8-823b-7eed8ae5fc28",
 *     "points": {
 *       "balance": 0,
 *       "earned": 0,
 *       "adjusted": 0,
 *       "redeemed": 0
 *     },
 *     "rewardAvailable": false,
 *     "_createdDate": "2022-11-09T12:49:25.408Z",
 *     "_updatedDate": "2022-11-09T12:49:25.408Z",
 *     "revision": "1"
 *   }
 * }
 */

Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?