> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GenerateReferringCustomerForContact # Package: referralProgram # Namespace: ReferringCustomers # Method link: https://dev.wix.com/docs/api-reference/business-management/marketing/referral-program/referring-customers/generate-referring-customer-for-contact.md ## Permission Scopes: Manage Referrals: SCOPE.DC-REFERRALS.MANAGE-REFERRALS ## Introduction Creates a new referring customer or returns an existing one for the provided contact ID. You can use `"me"` instead of a specific contact ID to generate a referring customer for the current identity's contact. See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) to learn more about identities. --- ## REST API ### Schema ``` Method: generateReferringCustomerForContact Description: Creates a new referring customer or returns an existing one for the provided contact GUID. You can use `"me"` instead of a specific contact GUID to generate a referring customer for the current identity's contact. See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) to learn more about identities. URL: https://www.wixapis.com/v1/referring-customers Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: contactId Method parameters: param name: contactId | type: contactId | description: Contact GUID or `"me"` to generate the current identity's referring customer. | required: true Return type: GenerateReferringCustomerForContactResponse - name: referringCustomer | type: ReferringCustomer | description: Created referring customer. - name: id | type: string | description: GUID of the referring customer. - name: contactId | type: string | description: Contact GUID associated with the referring customer. - name: referralCode | type: string | description: Unique code for the referral. For example, `GxpxwAoMqxH8`. - name: revision | type: string | description: Revision number, which increments by 1 each time the referring customer is updated. To prevent conflicting changes, the current revision must be passed when updating the referring customer. - name: createdDate | type: string | description: Date and time the referring customer was created. - name: updatedDate | type: string | description: Date and time the referring customer was last updated. ``` ### Examples ### Generate Referring Customer for Contact ```curl curl -X POST \ 'https://www.wixapis.com/referral-customers/v1/referring-customers' \ -H 'Authorization: ' \ -H 'Content-Type: application/json' \ -d '{ "contactId": "me" }' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.referralProgram.ReferringCustomers.generateReferringCustomerForContact(contactId) Description: Creates a new referring customer or returns an existing one for the provided contact GUID. You can use `"me"` instead of a specific contact GUID to generate a referring customer for the current identity's contact. See [About Identities](https://dev.wix.com/docs/build-apps/develop-your-app/access/about-identities.md) to learn more about identities. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: contactId Method parameters: param name: contactId | type: string | description: Contact GUID or `"me"` to generate the current identity's referring customer. | required: true Return type: PROMISE - name: referringCustomer | type: ReferringCustomer | description: Created referring customer. - name: _id | type: string | description: GUID of the referring customer. - name: contactId | type: string | description: Contact GUID associated with the referring customer. - name: referralCode | type: string | description: Unique code for the referral. For example, `GxpxwAoMqxH8`. - name: revision | type: string | description: Revision number, which increments by 1 each time the referring customer is updated. To prevent conflicting changes, the current revision must be passed when updating the referring customer. - name: _createdDate | type: Date | description: Date and time the referring customer was created. - name: _updatedDate | type: Date | description: Date and time the referring customer was last updated. ``` ### Examples ### generateReferringCustomerForContact ```javascript import { customers } from '@wix/referral'; async function generateReferringCustomerForContact(contactId) { const response = await customers.generateReferringCustomerForContact(contactId); }; ``` ### generateReferringCustomerForContact (with elevated permissions) ```javascript import { customers } from '@wix/referral'; import { auth } from '@wix/essentials'; async function myGenerateReferringCustomerForContactMethod(contactId) { const elevatedGenerateReferringCustomerForContact = auth.elevate(customers.generateReferringCustomerForContact); const response = await elevatedGenerateReferringCustomerForContact(contactId); } ``` ### generateReferringCustomerForContact (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { customers } from '@wix/referral'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { customers }, // Include the auth strategy and host as relevant }); async function generateReferringCustomerForContact(contactId) { const response = await myWixClient.customers.generateReferringCustomerForContact(contactId); }; ``` ---