Account Code: Sample Flows

This article presents possible use cases and corresponding sample flows that you can support. It provides a useful starting point as you plan your implementation.

Invite your users to Wix and link them to your account

You can bring a group of your users to Wix and have their Wix accounts linked to your account as sub-accounts. For example, when you onboard a new group of customers who need Wix sites.

To invite your users to Wix and link them to your account:

1. Call Generate Account Invite Links. Specify the number of links you need in count. Optionally, specify how long the links stay redeemable in expirationDurationInSeconds. The response contains one invite link for each account code that was created:

   Copy

2. Compare bulkActionMetadata.totalSuccesses with the count you specified. If fewer invite links were returned than you need, call Generate Account Invite Links again for the difference.

3. Store each invite link with the user you plan to send it to, so you can revoke it later if needed.

4. Send each user their invite link without modifying it. When the user opens the link and signs up or logs in to Wix, their account is linked to your account.

Revoke an invite link sent by mistake

If you sent an invite link to the wrong person, or no longer want it to be redeemable, you can revoke it before anyone redeems it.

To revoke an invite link:

1. Take the value of the organizationInviteCode query parameter from the invite link.
2. Call Delete Account Code and specify the value in inviteCode. The invite link can no longer be redeemed.

Clean up unused invite links

After a campaign ends, you can revoke all the invite links that your users haven't redeemed, so they can't be used later.

To clean up unused invite links:

1. Collect the organizationInviteCode values from the invite links you want to revoke.

2. Call Bulk Delete Account Codes and specify the values in inviteCodes. You can specify up to 5,000 invite codes in each call.

3. Check results in the response. Each item matches the invite code in the same position in your request. An invite code that's expired or doesn't exist is returned as a failed item:

   Copy