About the Contributors API

The Contributors API allows account managers to retrieve a list of contributors for a given site, change their roles, and manage their assigned locations. This API enables you to manage contributor roles, permissions, and location access, so you can ensure that your customers have the appropriate access to their Wix sites.

Important:

This API is designed to manage customer access to a single site and is not intended for managing company employee access to sites.

With the Contributors API, you can:

  • Query contributors by role or location to retrieve their account information.
  • Update a contributor's roles for a site, replacing all existing role assignments.
  • Update business locations within a contributor's role assignments.

For more information about site collaborators, including a list of available roles, see Roles & Permissions: Overview and Roles & Permissions: Information for Site Collaborators.

Before you begin

  • Wix recommends mapping your customers' identifiers (email, name, etc.) to their Wix user ID.

Use cases

Terminology

  • Account: A collection of Wix assets, including sites, managed by one or more Wix users. Every Wix user has an account that they own, and they can also be invited to join other user's accounts.
  • Assignment: The mapping of a Wix user's access to a site and their assigned role. For example, Sally has access to the XYZ site owned by Jennifer with a website manager role.
  • Collaborator: A Wix user with edit or manage access to a site owned by a separate Wix account. See Roles & Permissions: Overview and Roles & Permissions: Information for Site Collaborators.
  • Location: A physical location (such as a store or branch) associated with a multi-location business on Wix, managed in the Locations API. Contributors can be assigned to specific locations to limit their access and management capabilities to only those locations.
  • Policy: See Role below.
  • Role: A defined type of access that an identity should have on a specific site or account. Wix provides several predefined roles, such as co-owner, website manager, and website designer. Account owners and co-owners can also define their own custom roles.
  • User: A logged in user on *.wix.com.
Did this help?