Contributors API: Sample Flows

This article presents a possible use case and corresponding sample flow that you can support. This can be a helpful jumping off point as you plan your implementation.

Manage customer access to a site

You can manage which customers have access to a site and what level of access they have by querying contributors and updating their roles. This allows you to ensure customers have the appropriate permissions for their needs.

To manage customer access to a site:

  1. Call Query Site Contributors with any relevant filters to retrieve a list of contributor account IDs and account owner IDs. For example, filter by role ID to find all contributors with a specific role, or filter by location ID to find contributors assigned to specific business locations.

  2. If changes to a customer's roles are required, call Change Role with the customer's account ID and the new list of roles to assign. This replaces all existing role assignments for the contributor with the specified roles.

  3. If the contributor's role assignments need to be restricted to specific business locations, call Change Contributor Location with the customer's account ID and the location IDs to assign. This updates the locations within all of the contributor's role assignments.

Did this help?