> 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 # CreatePartnerProfile # Package: partners # Namespace: PartnerProfiles # Method link: https://dev.wix.com/docs/api-reference/account-level/partners/partner-profile-v1/create-partner-profile.md ## Introduction Creates a partner profile. --- ## REST API ### Schema ``` Method: createPartnerProfile Description: Creates a partner profile. URL: https://www.wixapis.com/partners/profile/v1/partner-profiles Method: POST # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: partnerProfile Method parameters: param name: partnerProfile | type: PartnerProfile | description: Represents a Wix Partner's editable profile in the partner directory. Partners use this entity to manage their own professional information, services offered, portfolio items, and contact details. Once a partner's updates pass verification, a new [PublicPartnerProfile] is published for unauthenticated public viewing. Read/write access to this entity is restricted to the authenticated partner who owns the profile. | required: true - name: id | type: string | description: Partner profile GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the partner profile is updated. To prevent conflicting changes, the current revision must be passed when updating the partner profile. | validation: format uint64 - name: services | type: Services | description: Services and minimum prices offered by this partner. - name: values | type: array | description: - name: id | type: string | description: GUID of the marketplace service category this partner offers. | validation: format GUID - name: minPrice | type: number | description: Minimum project price for this service, in USD. | validation: minimum 1, format double - name: address | type: Address | description: Partner's location. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street name and number. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number as free text. - name: country | type: string | description: Country code. | validation: format COUNTRY - name: subdivision | type: string | description: Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip/postal code. - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. - name: professionalInformation | type: ProfessionalInformation | description: Professional details about the partner, including business name, website, social media links, and contact email. - name: businessName | type: string | description: Partner's business or agency name. - name: businessWebsite | type: string | description: URL of the partner's business website. - name: tagline | type: string | description: Short headline displayed on the partner's profile page. - name: about | type: string | description: Free-text description of the partner's business, background, and areas of expertise. - name: profileImage | type: string | description: URL of the partner's profile image. - name: email | type: string | description: Partner's public contact email address, displayed on the profile page. This isn't the partner's Wix login email. | validation: format EMAIL - name: socials | type: Socials | description: Partner's social media profile links. - name: facebook | type: string | description: URL of the partner's Facebook page. | validation: format WEB_URL - name: linkedIn | type: string | description: URL of the partner's LinkedIn page. | validation: format WEB_URL - name: instagram | type: string | description: URL of the partner's Instagram page. | validation: format WEB_URL - name: pinterest | type: string | description: URL of the partner's Pinterest page. | validation: format WEB_URL - name: portfolio | type: Portfolio | description: Partner's portfolio of completed client work. Each item references a Wix site the partner built. - name: items | type: array | description: - name: metaSiteId | type: string | description: GUID of the Wix site featured in this portfolio item. | validation: format GUID - name: customImage | type: string | description: URL of a custom thumbnail image for this portfolio item. When set, overrides the site's auto-generated screenshot. - name: hidden | type: boolean | description: Whether this portfolio item is hidden from the partner's profile page. Hidden items are still returned in API responses. - name: siteName | type: string | description: Display name of the Wix site. Can be customized to differ from the actual site title. - name: description | type: string | description: Description of this portfolio item. - name: sitePlatform | type: SitePlatform | description: Platform used to build this site. - enum: - WIX: Site built using the classic Wix Editor. - STUDIO: Site built using Wix Studio. - name: slug | type: string | description: URL-friendly identifier used in the partner's public profile page URL. For example, `acme-studio`. Auto-generated from `professionalInformation.businessName` when the profile is created. Can be changed via the API. - name: platforms | type: Platforms | description: Wix platform products the partner works with. - name: wix | type: boolean | description: Partner builds sites using the classic Wix Editor. - name: studio | type: boolean | description: Partner builds sites using Wix Studio. - name: displayConfiguration | type: DisplayConfiguration | description: Partner-controlled display settings for the profile page. - name: hideTemplatesSection | type: boolean | description: Whether to hide the templates section from the partner's public profile page. - name: hideAppsSection | type: boolean | description: Whether to hide the apps section from the partner's public profile page. - name: servicesDisplayOrder | type: array | description: Ordered list of service GUIDs controlling the display order of the partner's services on their profile page. | validation: maxItems 100, format GUID - name: hideFromDirectory | type: boolean | description: Whether the partner has opted out of appearing in the Partner Directory listing. The public partner profile remains accessible via the API regardless of this setting. - name: languages | type: array | description: Languages the partner works in. Each value is a language code in BCP 47 format. For example, `en` for English or `fr-CA` for Canadian French. | validation: maxItems 100, format LANGUAGE - name: scheduling | type: SchedulingLink | description: Link allowing site visitors to schedule a meeting with the partner. - name: name | type: string | description: Display label for the scheduling link as it appears on the partner's profile page. For example, `Book a free consultation`. - name: link | type: string | description: URL for booking a meeting with the partner. | validation: format WEB_URL Return type: CreatePartnerProfileResponse - name: partnerProfile | type: PartnerProfile | description: Created partner profile. - name: id | type: string | description: Partner profile GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the partner profile is updated. To prevent conflicting changes, the current revision must be passed when updating the partner profile. | validation: format uint64 - name: createdDate | type: string | description: Date and time the partner profile was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the partner profile was last updated. | validation: format date-time - name: services | type: Services | description: Services and minimum prices offered by this partner. - name: values | type: array | description: - name: id | type: string | description: GUID of the marketplace service category this partner offers. | validation: format GUID - name: minPrice | type: number | description: Minimum project price for this service, in USD. | validation: minimum 1, format double - name: address | type: Address | description: Partner's location. - ONE-OF: - name: streetAddress | type: StreetAddress | description: Street name and number. - name: number | type: string | description: Street number. - name: name | type: string | description: Street name. - name: addressLine | type: string | description: Main address line, usually street and number as free text. - name: country | type: string | description: Country code. | validation: format COUNTRY - name: subdivision | type: string | description: Subdivision shorthand. Usually, a short code (2 or 3 letters) that represents a state, region, prefecture, or province. e.g. NY - name: city | type: string | description: City name. - name: postalCode | type: string | description: Zip/postal code. - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. - name: professionalInformation | type: ProfessionalInformation | description: Professional details about the partner, including business name, website, social media links, and contact email. - name: businessName | type: string | description: Partner's business or agency name. - name: businessWebsite | type: string | description: URL of the partner's business website. - name: tagline | type: string | description: Short headline displayed on the partner's profile page. - name: about | type: string | description: Free-text description of the partner's business, background, and areas of expertise. - name: profileImage | type: string | description: URL of the partner's profile image. - name: email | type: string | description: Partner's public contact email address, displayed on the profile page. This isn't the partner's Wix login email. | validation: format EMAIL - name: socials | type: Socials | description: Partner's social media profile links. - name: facebook | type: string | description: URL of the partner's Facebook page. | validation: format WEB_URL - name: linkedIn | type: string | description: URL of the partner's LinkedIn page. | validation: format WEB_URL - name: instagram | type: string | description: URL of the partner's Instagram page. | validation: format WEB_URL - name: pinterest | type: string | description: URL of the partner's Pinterest page. | validation: format WEB_URL - name: portfolio | type: Portfolio | description: Partner's portfolio of completed client work. Each item references a Wix site the partner built. - name: items | type: array | description: - name: metaSiteId | type: string | description: GUID of the Wix site featured in this portfolio item. | validation: format GUID - name: customImage | type: string | description: URL of a custom thumbnail image for this portfolio item. When set, overrides the site's auto-generated screenshot. - name: hidden | type: boolean | description: Whether this portfolio item is hidden from the partner's profile page. Hidden items are still returned in API responses. - name: siteName | type: string | description: Display name of the Wix site. Can be customized to differ from the actual site title. - name: description | type: string | description: Description of this portfolio item. - name: sitePlatform | type: SitePlatform | description: Platform used to build this site. - enum: - WIX: Site built using the classic Wix Editor. - STUDIO: Site built using Wix Studio. - name: slug | type: string | description: URL-friendly identifier used in the partner's public profile page URL. For example, `acme-studio`. Auto-generated from `professionalInformation.businessName` when the profile is created. Can be changed via the API. - name: platforms | type: Platforms | description: Wix platform products the partner works with. - name: wix | type: boolean | description: Partner builds sites using the classic Wix Editor. - name: studio | type: boolean | description: Partner builds sites using Wix Studio. - name: euValid | type: boolean | description: Whether this partner is verified as compliant with EU regulations. When `true`, you can display an EU compliance indicator on the partner's profile. Set automatically based on the partner's country and EU trader traceability status. When absent, EU compliance isn't applicable for this partner. - name: displayConfiguration | type: DisplayConfiguration | description: Partner-controlled display settings for the profile page. - name: hideTemplatesSection | type: boolean | description: Whether to hide the templates section from the partner's public profile page. - name: hideAppsSection | type: boolean | description: Whether to hide the apps section from the partner's public profile page. - name: servicesDisplayOrder | type: array | description: Ordered list of service GUIDs controlling the display order of the partner's services on their profile page. | validation: maxItems 100, format GUID - name: validation | type: Validation | description: Content verification status of this profile. Updated automatically after each change. Only changes that pass verification are reflected in the corresponding public partner profile. - name: validationStatus | type: ValidationStatus | description: Current status of content verification. - enum: - PENDING_VALIDATION: Profile content is awaiting verification. - VALID: Profile content has passed verification and is published to the public directory. - NOT_VALID: Profile content failed verification. See `failedValidationReasons` for details. To resolve, update the profile with corrected content. - name: failedValidationReasons | type: array | description: List of specific reasons if validation failed, each identifying the affected field and failure category. | validation: maxItems 100 - name: failureReason | type: FailureReason | description: The category of validation failure. - enum: - OFFENSIVE_CONTENT: Profile content contains offensive or inappropriate language. - MALICIOUS_CODE: Profile content contains malicious code. - ERROR: A system error occurred during verification. - COMPETITION: Profile content references a Wix competitor product or service. - HTTP_ERROR: The partner's website URL couldn't be reached during verification. - name: description | type: string | description: Human-readable explanation of why this validation failed. | validation: maxLength 2000 - name: field | type: string | description: The partner profile field that triggered this validation failure. For example, `professionalInformation.about`. | validation: maxLength 500 - name: hideFromDirectory | type: boolean | description: Whether the partner has opted out of appearing in the Partner Directory listing. The public partner profile remains accessible via the API regardless of this setting. - name: languages | type: array | description: Languages the partner works in. Each value is a language code in BCP 47 format. For example, `en` for English or `fr-CA` for Canadian French. | validation: maxItems 100, format LANGUAGE - name: scheduling | type: SchedulingLink | description: Link allowing site visitors to schedule a meeting with the partner. - name: name | type: string | description: Display label for the scheduling link as it appears on the partner's profile page. For example, `Book a free consultation`. - name: link | type: string | description: URL for booking a meeting with the partner. | validation: format WEB_URL ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.partnerProfiles.partnerProfiles.createPartnerProfile(partnerProfile) Description: Creates a partner profile. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: partnerProfile Method parameters: param name: partnerProfile | type: PartnerProfile | description: Represents a Wix Partner's editable profile in the partner directory. Partners use this entity to manage their own professional information, services offered, portfolio items, and contact details. Once a partner's updates pass verification, a new [PublicPartnerProfile] is published for unauthenticated public viewing. Read/write access to this entity is restricted to the authenticated partner who owns the profile. | required: true - name: _id | type: string | description: Partner profile GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the partner profile is updated. To prevent conflicting changes, the current revision must be passed when updating the partner profile. | validation: format uint64 - name: services | type: Services | description: Services and minimum prices offered by this partner. - name: values | type: array | description: - name: _id | type: string | description: GUID of the marketplace service category this partner offers. | validation: format GUID - name: minPrice | type: number | description: Minimum project price for this service, in USD. | validation: minimum 1 - name: address | type: Address | description: Partner's location. - name: location | type: Location | description: none - name: latitude | type: number | description: none - name: longitude | type: number | description: none - name: streetAddress | type: StreetAddress | description: none - name: name | type: string | description: none - name: number | type: string | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: formatted | type: string | description: none - name: addressLine1 | type: string | description: none - name: addressLine2 | type: string | description: none - name: professionalInformation | type: ProfessionalInformation | description: Professional details about the partner, including business name, website, social media links, and contact email. - name: businessName | type: string | description: Partner's business or agency name. - name: businessWebsite | type: string | description: URL of the partner's business website. - name: tagline | type: string | description: Short headline displayed on the partner's profile page. - name: about | type: string | description: Free-text description of the partner's business, background, and areas of expertise. - name: profileImage | type: string | description: URL of the partner's profile image. - name: email | type: string | description: Partner's public contact email address, displayed on the profile page. This isn't the partner's Wix login email. | validation: format EMAIL - name: socials | type: Socials | description: Partner's social media profile links. - name: facebook | type: string | description: URL of the partner's Facebook page. | validation: format WEB_URL - name: linkedIn | type: string | description: URL of the partner's LinkedIn page. | validation: format WEB_URL - name: instagram | type: string | description: URL of the partner's Instagram page. | validation: format WEB_URL - name: pinterest | type: string | description: URL of the partner's Pinterest page. | validation: format WEB_URL - name: portfolio | type: Portfolio | description: Partner's portfolio of completed client work. Each item references a Wix site the partner built. - name: items | type: array | description: - name: metaSiteId | type: string | description: GUID of the Wix site featured in this portfolio item. | validation: format GUID - name: customImage | type: string | description: URL of a custom thumbnail image for this portfolio item. When set, overrides the site's auto-generated screenshot. - name: hidden | type: boolean | description: Whether this portfolio item is hidden from the partner's profile page. Hidden items are still returned in API responses. - name: siteName | type: string | description: Display name of the Wix site. Can be customized to differ from the actual site title. - name: description | type: string | description: Description of this portfolio item. - name: sitePlatform | type: SitePlatform | description: Platform used to build this site. - enum: - WIX: Site built using the classic Wix Editor. - STUDIO: Site built using Wix Studio. - name: slug | type: string | description: URL-friendly identifier used in the partner's public profile page URL. For example, `acme-studio`. Auto-generated from `professionalInformation.businessName` when the profile is created. Can be changed via the API. - name: platforms | type: Platforms | description: Wix platform products the partner works with. - name: wix | type: boolean | description: Partner builds sites using the classic Wix Editor. - name: studio | type: boolean | description: Partner builds sites using Wix Studio. - name: displayConfiguration | type: DisplayConfiguration | description: Partner-controlled display settings for the profile page. - name: hideTemplatesSection | type: boolean | description: Whether to hide the templates section from the partner's public profile page. - name: hideAppsSection | type: boolean | description: Whether to hide the apps section from the partner's public profile page. - name: servicesDisplayOrder | type: array | description: Ordered list of service GUIDs controlling the display order of the partner's services on their profile page. | validation: maxItems 100, format GUID - name: hideFromDirectory | type: boolean | description: Whether the partner has opted out of appearing in the Partner Directory listing. The public partner profile remains accessible via the API regardless of this setting. - name: languages | type: array | description: Languages the partner works in. Each value is a language code in BCP 47 format. For example, `en` for English or `fr-CA` for Canadian French. | validation: maxItems 100, format LANGUAGE - name: scheduling | type: SchedulingLink | description: Link allowing site visitors to schedule a meeting with the partner. - name: name | type: string | description: Display label for the scheduling link as it appears on the partner's profile page. For example, `Book a free consultation`. - name: link | type: string | description: URL for booking a meeting with the partner. | validation: format WEB_URL Return type: PROMISE - name: _id | type: string | description: Partner profile GUID. | validation: format GUID - name: revision | type: string | description: Revision number, which increments by 1 each time the partner profile is updated. To prevent conflicting changes, the current revision must be passed when updating the partner profile. | validation: format uint64 - name: _createdDate | type: Date | description: Date and time the partner profile was created. - name: _updatedDate | type: Date | description: Date and time the partner profile was last updated. - name: services | type: Services | description: Services and minimum prices offered by this partner. - name: values | type: array | description: - name: _id | type: string | description: GUID of the marketplace service category this partner offers. | validation: format GUID - name: minPrice | type: number | description: Minimum project price for this service, in USD. | validation: minimum 1 - name: address | type: Address | description: Partner's location. - name: location | type: Location | description: none - name: latitude | type: number | description: none - name: longitude | type: number | description: none - name: streetAddress | type: StreetAddress | description: none - name: name | type: string | description: none - name: number | type: string | description: none - name: city | type: string | description: none - name: subdivision | type: string | description: none - name: country | type: string | description: none - name: postalCode | type: string | description: none - name: formatted | type: string | description: none - name: addressLine1 | type: string | description: none - name: addressLine2 | type: string | description: none - name: professionalInformation | type: ProfessionalInformation | description: Professional details about the partner, including business name, website, social media links, and contact email. - name: businessName | type: string | description: Partner's business or agency name. - name: businessWebsite | type: string | description: URL of the partner's business website. - name: tagline | type: string | description: Short headline displayed on the partner's profile page. - name: about | type: string | description: Free-text description of the partner's business, background, and areas of expertise. - name: profileImage | type: string | description: URL of the partner's profile image. - name: email | type: string | description: Partner's public contact email address, displayed on the profile page. This isn't the partner's Wix login email. | validation: format EMAIL - name: socials | type: Socials | description: Partner's social media profile links. - name: facebook | type: string | description: URL of the partner's Facebook page. | validation: format WEB_URL - name: linkedIn | type: string | description: URL of the partner's LinkedIn page. | validation: format WEB_URL - name: instagram | type: string | description: URL of the partner's Instagram page. | validation: format WEB_URL - name: pinterest | type: string | description: URL of the partner's Pinterest page. | validation: format WEB_URL - name: portfolio | type: Portfolio | description: Partner's portfolio of completed client work. Each item references a Wix site the partner built. - name: items | type: array | description: - name: metaSiteId | type: string | description: GUID of the Wix site featured in this portfolio item. | validation: format GUID - name: customImage | type: string | description: URL of a custom thumbnail image for this portfolio item. When set, overrides the site's auto-generated screenshot. - name: hidden | type: boolean | description: Whether this portfolio item is hidden from the partner's profile page. Hidden items are still returned in API responses. - name: siteName | type: string | description: Display name of the Wix site. Can be customized to differ from the actual site title. - name: description | type: string | description: Description of this portfolio item. - name: sitePlatform | type: SitePlatform | description: Platform used to build this site. - enum: - WIX: Site built using the classic Wix Editor. - STUDIO: Site built using Wix Studio. - name: slug | type: string | description: URL-friendly identifier used in the partner's public profile page URL. For example, `acme-studio`. Auto-generated from `professionalInformation.businessName` when the profile is created. Can be changed via the API. - name: platforms | type: Platforms | description: Wix platform products the partner works with. - name: wix | type: boolean | description: Partner builds sites using the classic Wix Editor. - name: studio | type: boolean | description: Partner builds sites using Wix Studio. - name: euValid | type: boolean | description: Whether this partner is verified as compliant with EU regulations. When `true`, you can display an EU compliance indicator on the partner's profile. Set automatically based on the partner's country and EU trader traceability status. When absent, EU compliance isn't applicable for this partner. - name: displayConfiguration | type: DisplayConfiguration | description: Partner-controlled display settings for the profile page. - name: hideTemplatesSection | type: boolean | description: Whether to hide the templates section from the partner's public profile page. - name: hideAppsSection | type: boolean | description: Whether to hide the apps section from the partner's public profile page. - name: servicesDisplayOrder | type: array | description: Ordered list of service GUIDs controlling the display order of the partner's services on their profile page. | validation: maxItems 100, format GUID - name: validation | type: Validation | description: Content verification status of this profile. Updated automatically after each change. Only changes that pass verification are reflected in the corresponding public partner profile. - name: validationStatus | type: ValidationStatus | description: Current status of content verification. - enum: - PENDING_VALIDATION: Profile content is awaiting verification. - VALID: Profile content has passed verification and is published to the public directory. - NOT_VALID: Profile content failed verification. See `failedValidationReasons` for details. To resolve, update the profile with corrected content. - name: failedValidationReasons | type: array | description: List of specific reasons if validation failed, each identifying the affected field and failure category. | validation: maxItems 100 - name: failureReason | type: FailureReason | description: The category of validation failure. - enum: - OFFENSIVE_CONTENT: Profile content contains offensive or inappropriate language. - MALICIOUS_CODE: Profile content contains malicious code. - ERROR: A system error occurred during verification. - COMPETITION: Profile content references a Wix competitor product or service. - HTTP_ERROR: The partner's website URL couldn't be reached during verification. - name: description | type: string | description: Human-readable explanation of why this validation failed. | validation: maxLength 2000 - name: field | type: string | description: The partner profile field that triggered this validation failure. For example, `professionalInformation.about`. | validation: maxLength 500 - name: hideFromDirectory | type: boolean | description: Whether the partner has opted out of appearing in the Partner Directory listing. The public partner profile remains accessible via the API regardless of this setting. - name: languages | type: array | description: Languages the partner works in. Each value is a language code in BCP 47 format. For example, `en` for English or `fr-CA` for Canadian French. | validation: maxItems 100, format LANGUAGE - name: scheduling | type: SchedulingLink | description: Link allowing site visitors to schedule a meeting with the partner. - name: name | type: string | description: Display label for the scheduling link as it appears on the partner's profile page. For example, `Book a free consultation`. - name: link | type: string | description: URL for booking a meeting with the partner. | validation: format WEB_URL ``` ### Examples ### createPartnerProfile ```javascript import { partnerProfiles } from '@wix/partner-profiles'; async function createPartnerProfile(partnerProfile) { const response = await partnerProfiles.createPartnerProfile(partnerProfile); }; ``` ### createPartnerProfile (with elevated permissions) ```javascript import { partnerProfiles } from '@wix/partner-profiles'; import { auth } from '@wix/essentials'; async function myCreatePartnerProfileMethod(partnerProfile) { const elevatedCreatePartnerProfile = auth.elevate(partnerProfiles.createPartnerProfile); const response = await elevatedCreatePartnerProfile(partnerProfile); } ``` ### createPartnerProfile (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 { partnerProfiles } from '@wix/partner-profiles'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { partnerProfiles }, // Include the auth strategy and host as relevant }); async function createPartnerProfile(partnerProfile) { const response = await myWixClient.partnerProfiles.createPartnerProfile(partnerProfile); }; ``` ---