# About the Account Code API

The Account Code API lets a Channel invite its users to Wix with one-time-use sign-in
invite links. When a user opens their link and signs up or logs in to Wix, their account
is linked to the Channel's account as a sub-account.

With the Account Code API, you can:

- Generate batches of ready-to-use sign-in invite links for your users.
- Delete account codes, so their invite links can no longer be redeemed.

## Account code lifecycle

Each invite link contains an account code. An account code goes through these stages:

1. **Generated**: [Generate Account Invite Links](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/generate-account-invite-links)
   creates the account code and returns its invite link. By default, the account code
   stays redeemable for 182 days. You can request a lifetime between 60 seconds and 1 year.
1. **Redeemed**: A user opens the invite link and signs up or logs in to Wix. Their
   account is linked to your account as a sub-account. Each account code can be redeemed
   once, and each email address can redeem a single account code from your account.
1. **Deleted or expired**: An account code that's deleted or past its expiration date
   can't be redeemed. Deleting an account code that was already redeemed removes only
   the code. The user who redeemed it stays linked to your account.

## Before you begin

It's important to note the following points before starting to code:

- Your account must be set up by Wix as a Channel organization account. To get set up,
  contact your Wix partner manager. Otherwise, generating invite links fails with
  `ORGANIZATION_NOT_ELIGIBLE`.
- Call these methods with an account-level
  [API key](portalId::3aad3f6f-49bb-4d59-8817-0844f1da8b9fresourceId::e9167a2b-1ed9-46d6-8e02-74d20d9152b9*fallback::https://dev.wix.com/docs/api-reference/articles/authentication/api-keys/make-api-calls-with-an-api-key) that has the
  Manage Channels Account Codes permission scope. The account that the API key belongs to
  is always the account the codes are generated for or deleted from. You can't act on
  another account's codes.
- An account can have up to 5,000,000 active account codes, meaning codes that haven't
  been redeemed and haven't expired. If generating a batch would exceed this limit, the
  call fails and no account codes are created.
- If some account codes in a batch can't be created, for example due to a temporary
  storage issue, the call still succeeds and returns fewer invite links than you
  requested. The response reports how many account codes were created and how many failed.
- An invite code that belongs to a different account returns the same error as an invite
  code that doesn't exist.

## Use cases

- [Invite your users to Wix and link them to your account](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/sample-flows#invite-your-users-to-wix-and-link-them-to-your-account)
- [Revoke an invite link sent by mistake](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/sample-flows#revoke-an-invite-link-sent-by-mistake)
- [Clean up unused invite links](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/sample-flows#clean-up-unused-invite-links)

## Terminology

- **Channel**: A partner integration that's set up by Wix as an organization account.
  A Channel refers its users to Wix and has those users linked to its own account.
- **Organization account**: The Wix account that represents a Channel. It appears as
  `organizationId` in invite links.
- **Sub-account**: A user's Wix account that's linked to a Channel's organization account.
- **Account code**: A signed, one-time-use code that links the account of the user who
  redeems it to a Channel's account.
- **Invite link**: A full sign-in URL that contains an account code. For example,
  `https://users.wix.com/signin?organizationId=<accountId>&organizationInviteCode=<code>`.
- **Invite code**: The value of the `organizationInviteCode` query parameter in an invite
  link. Use it to identify an account code when you delete it.

@sdk_package_setup

# 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](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/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:

   ```json
   {
     "inviteLinks": [
       "https://users.wix.com/signin?organizationId=6b1f9e6a-3c2d-4f0e-9a1b-7e5d2c8f4a6b&organizationInviteCode=eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..q3Xk9mPzT2vL8nRw4bYc1A.Hf7sK2mQ9xV4pL6tN1rW8eZ3uB5yC0dJ.Ra4Tn8Wq2Ls6Xv1Kp9Bm3g",
       "https://users.wix.com/signin?organizationId=6b1f9e6a-3c2d-4f0e-9a1b-7e5d2c8f4a6b&organizationInviteCode=eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0..Lr7Tb2WnX5cQ8mPa1vKs3D.Mc2vR8tY5nK1wQ7pL4xZ9bH6sE3jF0gA.Uy6Pk1Rz9Nf4Wc2Lt7Hq5e"
     ],
     "bulkActionMetadata": {
       "totalSuccesses": 2,
       "totalFailures": 0
     }
   }
   ```

1. 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.
1. Store each invite link with the user you plan to send it to, so you can revoke it later
   if needed.
1. 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.
1. Call [Delete Account Code](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/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.
1. Call [Bulk Delete Account Codes](fallback::https://dev.wix.com/docs/api-reference/account-level/channels/eligibility/account-code-v1/bulk-delete-account-codes)
   and specify the values in `inviteCodes`. You can specify up to 5,000 invite codes in
   each call.
1. 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:

   ```json
   {
     "results": [
       { "itemMetadata": { "originalIndex": 0, "success": true } },
       {
         "itemMetadata": {
           "originalIndex": 1,
           "success": false,
           "error": {
             "code": "ACCOUNT_CODE_NOT_FOUND",
             "description": "Code does not resolve to an AccountCode this caller can reach"
           }
         }
       }
     ],
     "bulkActionMetadata": {
       "totalSuccesses": 1,
       "totalFailures": 1
     }
   }
   ```

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Extend Websites with SDK

Build Apps

Client (Deprecated)

API Preview

Wix CLI

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso