Skip to navigation
Rooms API 101Forms

Managing forms

View as Markdown

Forms are standard preset documents imported to your company’s Rooms account for easy reuse.

Note: Forms is a Rooms for Real Estate feature. There is no comparable feature in Rooms for Mortgage.

Managing forms access

Forms access policies and Forms Groups are created and managed by forms administrators. A user must have the rooms_forms permission assigned to their user to become a forms administrator; this gives them access to the FORMS tab in the Rooms admin panel.

Note: Form access is office-specific. If a member has access only to specific offices, they can only administer form groups for those offices. During the process of setting up the Forms feature, you can set a different permission, “Manage form libraries,” that enables you to make individual libraries visible to specific offices.

Form groups

Expanded by Rooms API v2

The Form groups feature enables you to connect any number of your forms into a group that you can share to specific roles and offices. This is useful to:

  • Help your agents easily find and choose the forms they need to work with, rather than having to look through large libraries to find them. Form groups only contain the forms from your libraries that you choose.
  • Create groups of forms used in specific tasks that your agents perform frequently. You can share your form groups with specific offices to ensure that your agents they have exactly what they need for their work.
  • Share forms from multiple libraries to agents without sharing the full contents of each library. You (or any users who you authorize to manage the form group) can take any form from any libraries that you can access and add it to a form group.

To work with form groups in v2 of the Rooms API, you need to add the manage form groups scope to your OAuth request in addition to the existing Rooms API scopes.

See How to create a form group for an example of how to define a new form group using the API.

Next steps