Create User Group

Create a new User Group record.

Optional fields

Any request field marked nullable in the schema may be omitted from the payload entirely - you don't need to send it as null. On a PATCH (partial update), an omitted field is left unchanged; on a POST it's left unset.

Available Permissions

| Permission | Description | |---|---| | applications_add | Create new records for Applications. | | applications_credit_check | Run credit checks for Applications. | | applications_delete | Delete records for Applications. | | applications_delete_own | Delete own records for Applications. | | applications_export | Export Applications. | | applications_reports | Access/run reports for Applications. | | applications_update | Update records for Applications. | | applications_update_own | Update own records for Applications. | | applications_view | View Applications. | | applications_view_notes | View notes/activity log entries for Applications. | | applications_view_own | View own records for Applications. | | apply_to_all_branches | Bypass the branch scoping restriction and view/manage records across all branches (not just assigned ones). | | assets_add | Create new records for Assets. | | assets_add_notes | Add notes/activity log entries for Assets. | | assets_delete | Delete records for Assets. | | assets_export | Export Assets. | | assets_update | Update records for Assets. | | assets_view | View Assets. | | assets_view_notes | View notes/activity log entries for Assets. | | branches_add | Create new records for Branches. | | branches_add_notes | Add notes/activity log entries for Branches. | | branches_archive | Archive Branches. | | branches_export | Export Branches. | | branches_reports | View/access branch reports. | | branches_reports_add | Create new records for branch reports. | | branches_reports_delete | Delete records for branch reports. | | branches_reports_delete_own | Delete own records for branch reports. | | branches_reports_update | Update records for branch reports. | | branches_reports_update_own | Update own records for branch reports. | | branches_reports_view | View branch reports. | | branches_reports_view_own | View own records for branch reports. | | branches_update | Update records for Branches. | | branches_update_serviced_locations | Update serviced locations for Branches. | | branches_view_notes | View notes/activity log entries for Branches. | | brand_assets_add | Create new records for Brand assets. | | brand_assets_delete | Delete records for Brand assets. | | brand_assets_delete_own | Delete own records for Brand assets. | | brand_assets_export | Export Brand assets. | | brand_assets_update | Update records for Brand assets. | | brand_assets_update_own | Update own records for Brand assets. | | brand_assets_view | View Brand assets. | | brand_assets_view_own | View own records for Brand assets. | | bulk_mailing_add | Create new records for Bulk mailing campaigns. | | bulk_mailing_delete | Delete records for Bulk mailing campaigns. | | bulk_mailing_delete_own | Delete own records for Bulk mailing campaigns. | | bulk_mailing_export | Export Bulk mailing campaigns. | | bulk_mailing_update | Update records for Bulk mailing campaigns. | | bulk_mailing_update_own | Update own records for Bulk mailing campaigns. | | bulk_mailing_view | View Bulk mailing campaigns. | | bulk_mailing_view_automation | View bulk mailing automation workflows. | | bulk_mailing_view_own | View own records for Bulk mailing campaigns. | | canvassing_add | Create new records for Canvassing. | | canvassing_export | Export Canvassing. | | canvassing_reports | Access/run reports for Canvassing. | | canvassing_update | Update records for Canvassing. | | canvassing_update_own | Update own records for Canvassing. | | canvassing_view | View Canvassing. | | canvassing_view_own | View own records for Canvassing. | | cms_add | Create new records for CMS / website content. | | cms_add_notes | Add notes/activity log entries for CMS / website content. | | cms_export | Export CMS / website content. | | cms_update | Update records for CMS / website content. | | cms_view | View CMS / website content. | | cms_view_notes | View notes/activity log entries for CMS / website content. | | collections_add | Create new records for Collections. | | collections_add_notes | Add notes/activity log entries for Collections. | | collections_delete | Delete records for Collections. | | collections_delete_own | Delete own records for Collections. | | collections_export | Export Collections. | | collections_update | Update records for Collections. | | collections_update_own | Update own records for Collections. | | collections_view | View Collections. | | collections_view_notes | View notes/activity log entries for Collections. | | collections_view_own | View own records for Collections. | | contact_types_add | Create new records for Contact types. | | contacts_add | Create new records for Contacts. | | contacts_add_notes | Add notes/activity log entries for Contacts. | | contacts_associated_agents_update | Update records for contacts' associated agents. | | contacts_associated_agents_view | View contacts' associated agents. | | contacts_delete | Delete records for Contacts. | | contacts_delete_own | Delete own records for Contacts. | | contacts_export | Export Contacts. | | contacts_reports | View/access contact reports. | | contacts_reports_add | Create new records for contact reports. | | contacts_reports_delete | Delete records for contact reports. | | contacts_reports_delete_own | Delete own records for contact reports. | | contacts_reports_update | Update records for contact reports. | | contacts_reports_update_own | Update own records for contact reports. | | contacts_reports_view | View contact reports. | | contacts_reports_view_own | View own records for contact reports. | | contacts_update | Update records for Contacts. | | contacts_update_own | Update own records for Contacts. | | contacts_update_team | Update team members' records for Contacts. | | contacts_view | View Contacts. | | contacts_view_notes | View notes/activity log entries for Contacts. | | contacts_view_own | View own records for Contacts. | | contacts_view_team | View team members' records for Contacts. | | contacts_view_unassigned | View unassigned records for Contacts. | | deals_add | Create new records for Deals. | | deals_add_notes | Add notes/activity log entries for Deals. | | deals_export | Export Deals. | | deals_reports | View/access deal reports. | | deals_reports_add | Create new records for deal reports. | | deals_reports_delete | Delete records for deal reports. | | deals_reports_delete_own | Delete own records for deal reports. | | deals_reports_update | Update records for deal reports. | | deals_reports_update_own | Update own records for deal reports. | | deals_reports_view | View deal reports. | | deals_reports_view_own | View own records for deal reports. | | deals_update | Update records for Deals. | | deals_update_invoicing | Update invoicing details for Deals. | | deals_update_own | Update own records for Deals. | | deals_update_super | Update with elevated (super) access for Deals. | | deals_view | View Deals. | | deals_view_notes | View notes/activity log entries for Deals. | | deals_view_own | View own records for Deals. | | designations_add | Create new records for Designations. | | documents_add | Create new records for Documents. | | documents_add_notes | Add notes/activity log entries for Documents. | | documents_delete | Delete records for Documents. | | documents_export | Export Documents. | | documents_update | Update records for Documents. | | documents_view | View Documents. | | documents_view_notes | View notes/activity log entries for Documents. | | franchises_add | Create new records for Franchises. | | franchises_add_notes | Add notes/activity log entries for Franchises. | | franchises_divisions_add | Create new records for franchise divisions. | | franchises_export | Export Franchises. | | franchises_regions_add | Create new records for franchise regions. | | franchises_reports | View/access franchise reports. | | franchises_reports_add | Create new records for franchise reports. | | franchises_reports_delete | Delete records for franchise reports. | | franchises_reports_delete_own | Delete own records for franchise reports. | | franchises_reports_update | Update records for franchise reports. | | franchises_reports_update_own | Update own records for franchise reports. | | franchises_reports_view | View franchise reports. | | franchises_reports_view_own | View own records for franchise reports. | | franchises_update | Update records for Franchises. | | franchises_update_own | Update own records for Franchises. | | franchises_view | View Franchises. | | franchises_view_notes | View notes/activity log entries for Franchises. | | franchises_view_own | View own records for Franchises. | | insights_view | View the Insights dashboard. | | journey_mailer_view | View Journey mailer. | | leads_add | Create new records for Leads. | | leads_add_notes | Add notes/activity log entries for Leads. | | leads_contacts_associated_agents_update | Update records for leads' associated agents. | | leads_contacts_associated_agents_view | View leads' associated agents. | | leads_delete | Delete records for Leads. | | leads_delete_own | Delete own records for Leads. | | leads_export | Export Leads. | | leads_reports | View/access lead reports. | | leads_reports_add | Create new records for lead reports. | | leads_reports_delete | Delete records for lead reports. | | leads_reports_delete_own | Delete own records for lead reports. | | leads_reports_update | Update records for lead reports. | | leads_reports_update_own | Update own records for lead reports. | | leads_reports_view | View lead reports. | | leads_reports_view_own | View own records for lead reports. | | leads_sms_report_add | Create new records for lead SMS reports. | | leads_sms_report_delete | Delete records for lead SMS reports. | | leads_sms_report_delete_own | Delete own records for lead SMS reports. | | leads_sms_report_update | Update records for lead SMS reports. | | leads_sms_report_update_own | Update own records for lead SMS reports. | | leads_sms_report_view | View lead SMS reports. | | leads_sms_report_view_own | View own records for lead SMS reports. | | leads_update | Update records for Leads. | | leads_update_own | Update own records for Leads. | | leads_update_team | Update team members' records for Leads. | | leads_view | View Leads. | | leads_view_notes | View notes/activity log entries for Leads. | | leads_view_own | View own records for Leads. | | leads_view_team | View team members' records for Leads. | | leads_view_unassigned | View unassigned records for Leads. | | listings_commercial_add_notes | Add notes/activity log entries for Commercial listings (general). | | listings_commercial_disallow_custom_ref_numbers | Restrict custom reference numbers for Commercial listings (general). | | listings_commercial_for_sale_add | Create new records for Commercial For-Sale listings. | | listings_commercial_for_sale_auction | Manage auction settings for Commercial For-Sale listings. | | listings_commercial_for_sale_can_select_agent_featured | Mark records as agent-featured for Commercial For-Sale listings. | | listings_commercial_for_sale_can_select_branch_featured | Mark records as branch-featured for Commercial For-Sale listings. | | listings_commercial_for_sale_can_select_featured | Mark records as featured for Commercial For-Sale listings. | | listings_commercial_for_sale_display_on_website | Toggle website display for Commercial For-Sale listings. | | listings_commercial_for_sale_export | Export Commercial For-Sale listings. | | listings_commercial_for_sale_feed_to_portals | Toggle portal syndication feed for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report | Trigger seller feedback report generation for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_add | Create seller feedback report requests for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_delete | Delete any seller feedback report request for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_update | Update any seller feedback report request for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_view | View seller feedback report requests for Commercial For-Sale listings. | | listings_commercial_for_sale_generate_seller_feedback_report_view_own | View own seller feedback report requests for Commercial For-Sale listings. | | listings_commercial_for_sale_property_permit | Manage property permit details for Commercial For-Sale listings. | | listings_commercial_for_sale_reports | Access/run reports for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_add | Create saved reports for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_delete | Delete any saved report for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_delete_own | Delete own saved reports for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_update | Update any saved report for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_update_own | Update own saved reports for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_view | View saved reports for Commercial For-Sale listings. | | listings_commercial_for_sale_reports_view_own | View own saved reports for Commercial For-Sale listings. | | listings_commercial_for_sale_select_agent_newsletter_featured | Select agent-featured newsletter items for Commercial For-Sale listings. | | listings_commercial_for_sale_select_newsletter_featured | Select newsletter-featured items for Commercial For-Sale listings. | | listings_commercial_for_sale_update | Update records for Commercial For-Sale listings. | | listings_commercial_for_sale_update_own | Update own records for Commercial For-Sale listings. | | listings_commercial_for_sale_update_team | Update team members' records for Commercial For-Sale listings. | | listings_commercial_for_sale_view | View Commercial For-Sale listings. | | listings_commercial_for_sale_view_own | View own records for Commercial For-Sale listings. | | listings_commercial_for_sale_view_team | View team members' records for Commercial For-Sale listings. | | listings_commercial_to_let_add | Create new records for Commercial To-Let listings. | | listings_commercial_to_let_can_select_agent_featured | Mark records as agent-featured for Commercial To-Let listings. | | listings_commercial_to_let_can_select_branch_featured | Mark records as branch-featured for Commercial To-Let listings. | | listings_commercial_to_let_can_select_featured | Mark records as featured for Commercial To-Let listings. | | listings_commercial_to_let_display_on_website | Toggle website display for Commercial To-Let listings. | | listings_commercial_to_let_export | Export Commercial To-Let listings. | | listings_commercial_to_let_feed_to_portals | Toggle portal syndication feed for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report | Trigger seller feedback report generation for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_add | Create seller feedback report requests for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_delete | Delete any seller feedback report request for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_update | Update any seller feedback report request for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_view | View seller feedback report requests for Commercial To-Let listings. | | listings_commercial_to_let_generate_seller_feedback_report_view_own | View own seller feedback report requests for Commercial To-Let listings. | | listings_commercial_to_let_property_permit | Manage property permit details for Commercial To-Let listings. | | listings_commercial_to_let_reports | Access/run reports for Commercial To-Let listings. | | listings_commercial_to_let_reports_add | Create saved reports for Commercial To-Let listings. | | listings_commercial_to_let_reports_delete | Delete any saved report for Commercial To-Let listings. | | listings_commercial_to_let_reports_delete_own | Delete own saved reports for Commercial To-Let listings. | | listings_commercial_to_let_reports_update | Update any saved report for Commercial To-Let listings. | | listings_commercial_to_let_reports_update_own | Update own saved reports for Commercial To-Let listings. | | listings_commercial_to_let_reports_view | View saved reports for Commercial To-Let listings. | | listings_commercial_to_let_reports_view_own | View own saved reports for Commercial To-Let listings. | | listings_commercial_to_let_select_agent_newsletter_featured | Select agent-featured newsletter items for Commercial To-Let listings. | | listings_commercial_to_let_select_newsletter_featured | Select newsletter-featured items for Commercial To-Let listings. | | listings_commercial_to_let_update | Update records for Commercial To-Let listings. | | listings_commercial_to_let_update_own | Update own records for Commercial To-Let listings. | | listings_commercial_to_let_update_team | Update team members' records for Commercial To-Let listings. | | listings_commercial_to_let_view | View Commercial To-Let listings. | | listings_commercial_to_let_view_own | View own records for Commercial To-Let listings. | | listings_commercial_to_let_view_team | View team members' records for Commercial To-Let listings. | | listings_commercial_view_notes | View notes/activity log entries for Commercial listings (general). | | listings_holiday_add | Create new records for Holiday listings. | | listings_holiday_add_notes | Add notes/activity log entries for Holiday listings. | | listings_holiday_can_select_agent_featured | Mark records as agent-featured for Holiday listings. | | listings_holiday_can_select_branch_featured | Mark records as branch-featured for Holiday listings. | | listings_holiday_can_select_featured | Mark records as featured for Holiday listings. | | listings_holiday_disallow_custom_ref_numbers | Restrict custom reference numbers for Holiday listings. | | listings_holiday_display_on_website | Toggle website display for Holiday listings. | | listings_holiday_export | Export Holiday listings. | | listings_holiday_feed_to_portals | Toggle portal syndication feed for Holiday listings. | | listings_holiday_generate_seller_feedback_report | Trigger seller feedback report generation for Holiday listings. | | listings_holiday_generate_seller_feedback_report_add | Create seller feedback report requests for Holiday listings. | | listings_holiday_generate_seller_feedback_report_delete | Delete any seller feedback report request for Holiday listings. | | listings_holiday_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Holiday listings. | | listings_holiday_generate_seller_feedback_report_update | Update any seller feedback report request for Holiday listings. | | listings_holiday_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Holiday listings. | | listings_holiday_generate_seller_feedback_report_view | View seller feedback report requests for Holiday listings. | | listings_holiday_generate_seller_feedback_report_view_own | View own seller feedback report requests for Holiday listings. | | listings_holiday_reports | Access/run reports for Holiday listings. | | listings_holiday_reports_add | Create saved reports for Holiday listings. | | listings_holiday_reports_delete | Delete any saved report for Holiday listings. | | listings_holiday_reports_delete_own | Delete own saved reports for Holiday listings. | | listings_holiday_reports_update | Update any saved report for Holiday listings. | | listings_holiday_reports_update_own | Update own saved reports for Holiday listings. | | listings_holiday_reports_view | View saved reports for Holiday listings. | | listings_holiday_reports_view_own | View own saved reports for Holiday listings. | | listings_holiday_select_agent_newsletter_featured | Select agent-featured newsletter items for Holiday listings. | | listings_holiday_select_newsletter_featured | Select newsletter-featured items for Holiday listings. | | listings_holiday_update | Update records for Holiday listings. | | listings_holiday_update_own | Update own records for Holiday listings. | | listings_holiday_update_team | Update team members' records for Holiday listings. | | listings_holiday_view | View Holiday listings. | | listings_holiday_view_notes | View notes/activity log entries for Holiday listings. | | listings_holiday_view_own | View own records for Holiday listings. | | listings_holiday_view_team | View team members' records for Holiday listings. | | listings_projects_add | Create new records for Project listings. | | listings_projects_add_notes | Add notes/activity log entries for Project listings. | | listings_projects_can_select_agent_featured | Mark records as agent-featured for Project listings. | | listings_projects_can_select_branch_featured | Mark records as branch-featured for Project listings. | | listings_projects_can_select_featured | Mark records as featured for Project listings. | | listings_projects_disallow_custom_ref_numbers | Restrict custom reference numbers for Project listings. | | listings_projects_display_on_website | Toggle website display for Project listings. | | listings_projects_export | Export Project listings. | | listings_projects_feed_to_portals | Toggle portal syndication feed for Project listings. | | listings_projects_generate_seller_feedback_report | Trigger seller feedback report generation for Project listings. | | listings_projects_generate_seller_feedback_report_add | Create seller feedback report requests for Project listings. | | listings_projects_generate_seller_feedback_report_delete | Delete any seller feedback report request for Project listings. | | listings_projects_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Project listings. | | listings_projects_generate_seller_feedback_report_update | Update any seller feedback report request for Project listings. | | listings_projects_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Project listings. | | listings_projects_generate_seller_feedback_report_view | View seller feedback report requests for Project listings. | | listings_projects_generate_seller_feedback_report_view_own | View own seller feedback report requests for Project listings. | | listings_projects_reports | Access/run reports for Project listings. | | listings_projects_reports_add | Create saved reports for Project listings. | | listings_projects_reports_delete | Delete any saved report for Project listings. | | listings_projects_reports_delete_own | Delete own saved reports for Project listings. | | listings_projects_reports_update | Update any saved report for Project listings. | | listings_projects_reports_update_own | Update own saved reports for Project listings. | | listings_projects_reports_view | View saved reports for Project listings. | | listings_projects_reports_view_own | View own saved reports for Project listings. | | listings_projects_select_agent_newsletter_featured | Select agent-featured newsletter items for Project listings. | | listings_projects_select_newsletter_featured | Select newsletter-featured items for Project listings. | | listings_projects_update | Update records for Project listings. | | listings_projects_update_own | Update own records for Project listings. | | listings_projects_update_team | Update team members' records for Project listings. | | listings_projects_view | View Project listings. | | listings_projects_view_notes | View notes/activity log entries for Project listings. | | listings_projects_view_own | View own records for Project listings. | | listings_projects_view_team | View team members' records for Project listings. | | listings_residential_add_notes | Add notes/activity log entries for Residential listings (general). | | listings_residential_disallow_custom_ref_numbers | Restrict custom reference numbers for Residential listings (general). | | listings_residential_for_sale_add | Create new records for Residential For-Sale listings. | | listings_residential_for_sale_auction | Manage auction settings for Residential For-Sale listings. | | listings_residential_for_sale_can_select_agent_featured | Mark records as agent-featured for Residential For-Sale listings. | | listings_residential_for_sale_can_select_branch_featured | Mark records as branch-featured for Residential For-Sale listings. | | listings_residential_for_sale_can_select_featured | Mark records as featured for Residential For-Sale listings. | | listings_residential_for_sale_display_on_website | Toggle website display for Residential For-Sale listings. | | listings_residential_for_sale_export | Export Residential For-Sale listings. | | listings_residential_for_sale_feed_to_portals | Toggle portal syndication feed for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report | Trigger seller feedback report generation for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_add | Create seller feedback report requests for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_delete | Delete any seller feedback report request for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_update | Update any seller feedback report request for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_view | View seller feedback report requests for Residential For-Sale listings. | | listings_residential_for_sale_generate_seller_feedback_report_view_own | View own seller feedback report requests for Residential For-Sale listings. | | listings_residential_for_sale_property_permit | Manage property permit details for Residential For-Sale listings. | | listings_residential_for_sale_reports | Access/run reports for Residential For-Sale listings. | | listings_residential_for_sale_reports_add | Create saved reports for Residential For-Sale listings. | | listings_residential_for_sale_reports_delete | Delete any saved report for Residential For-Sale listings. | | listings_residential_for_sale_reports_delete_own | Delete own saved reports for Residential For-Sale listings. | | listings_residential_for_sale_reports_update | Update any saved report for Residential For-Sale listings. | | listings_residential_for_sale_reports_update_own | Update own saved reports for Residential For-Sale listings. | | listings_residential_for_sale_reports_view | View saved reports for Residential For-Sale listings. | | listings_residential_for_sale_reports_view_own | View own saved reports for Residential For-Sale listings. | | listings_residential_for_sale_select_agent_newsletter_featured | Select agent-featured newsletter items for Residential For-Sale listings. | | listings_residential_for_sale_select_newsletter_featured | Select newsletter-featured items for Residential For-Sale listings. | | listings_residential_for_sale_update | Update records for Residential For-Sale listings. | | listings_residential_for_sale_update_own | Update own records for Residential For-Sale listings. | | listings_residential_for_sale_update_team | Update team members' records for Residential For-Sale listings. | | listings_residential_for_sale_view | View Residential For-Sale listings. | | listings_residential_for_sale_view_own | View own records for Residential For-Sale listings. | | listings_residential_for_sale_view_team | View team members' records for Residential For-Sale listings. | | listings_residential_to_let_add | Create new records for Residential To-Let listings. | | listings_residential_to_let_can_select_agent_featured | Mark records as agent-featured for Residential To-Let listings. | | listings_residential_to_let_can_select_branch_featured | Mark records as branch-featured for Residential To-Let listings. | | listings_residential_to_let_can_select_featured | Mark records as featured for Residential To-Let listings. | | listings_residential_to_let_display_on_website | Toggle website display for Residential To-Let listings. | | listings_residential_to_let_export | Export Residential To-Let listings. | | listings_residential_to_let_feed_to_portals | Toggle portal syndication feed for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report | Trigger seller feedback report generation for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_add | Create seller feedback report requests for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_delete | Delete any seller feedback report request for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_delete_own | Delete own seller feedback report requests for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_update | Update any seller feedback report request for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_update_own | Update own seller feedback report requests for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_view | View seller feedback report requests for Residential To-Let listings. | | listings_residential_to_let_generate_seller_feedback_report_view_own | View own seller feedback report requests for Residential To-Let listings. | | listings_residential_to_let_property_permit | Manage property permit details for Residential To-Let listings. | | listings_residential_to_let_reports | Access/run reports for Residential To-Let listings. | | listings_residential_to_let_reports_add | Create saved reports for Residential To-Let listings. | | listings_residential_to_let_reports_delete | Delete any saved report for Residential To-Let listings. | | listings_residential_to_let_reports_delete_own | Delete own saved reports for Residential To-Let listings. | | listings_residential_to_let_reports_update | Update any saved report for Residential To-Let listings. | | listings_residential_to_let_reports_update_own | Update own saved reports for Residential To-Let listings. | | listings_residential_to_let_reports_view | View saved reports for Residential To-Let listings. | | listings_residential_to_let_reports_view_own | View own saved reports for Residential To-Let listings. | | listings_residential_to_let_select_agent_newsletter_featured | Select agent-featured newsletter items for Residential To-Let listings. | | listings_residential_to_let_select_newsletter_featured | Select newsletter-featured items for Residential To-Let listings. | | listings_residential_to_let_update | Update records for Residential To-Let listings. | | listings_residential_to_let_update_own | Update own records for Residential To-Let listings. | | listings_residential_to_let_update_team | Update team members' records for Residential To-Let listings. | | listings_residential_to_let_view | View Residential To-Let listings. | | listings_residential_to_let_view_own | View own records for Residential To-Let listings. | | listings_residential_to_let_view_team | View team members' records for Residential To-Let listings. | | listings_residential_view_notes | View notes/activity log entries for Residential listings (general). | | location_profiles_add | Create new records for Location profiles. | | location_profiles_export | Export Location profiles. | | location_profiles_update | Update records for Location profiles. | | location_profiles_view | View Location profiles. | | mailing_list_add | Create new records for Mailing list / subscribers. | | mailing_list_add_notes | Add notes/activity log entries for Mailing list / subscribers. | | mailing_list_contacts_associated_agents_update | Update records for mailing list contacts' associated agents. | | mailing_list_contacts_associated_agents_view | View mailing list contacts' associated agents. | | mailing_list_delete | Delete records for Mailing list / subscribers. | | mailing_list_delete_own | Delete own records for Mailing list / subscribers. | | mailing_list_export | Export Mailing list / subscribers. | | mailing_list_import | Import records into Mailing list / subscribers. | | mailing_list_reports | View/access mailing list reports. | | mailing_list_reports_add | Create new records for mailing list reports. | | mailing_list_reports_delete | Delete records for mailing list reports. | | mailing_list_reports_delete_own | Delete own records for mailing list reports. | | mailing_list_reports_update | Update records for mailing list reports. | | mailing_list_reports_update_own | Update own records for mailing list reports. | | mailing_list_reports_view | View mailing list reports. | | mailing_list_reports_view_own | View own records for mailing list reports. | | mailing_list_update | Update records for Mailing list / subscribers. | | mailing_list_update_own | Update own records for Mailing list / subscribers. | | mailing_list_view | View Mailing list / subscribers. | | mailing_list_view_notes | View notes/activity log entries for Mailing list / subscribers. | | mailing_list_view_own | View own records for Mailing list / subscribers. | | news_add | Create new records for News articles. | | news_add_notes | Add notes/activity log entries for News articles. | | news_categories_add | Create new records for news categories. | | news_export | Export News articles. | | news_update | Update records for News articles. | | news_view | View News articles. | | news_view_notes | View notes/activity log entries for News articles. | | newsletter_edit | Edit Newsletters. | | newsletter_report | View/access newsletter reports. | | newsletter_report_add | Create new records for newsletter reports. | | newsletter_report_delete | Delete records for newsletter reports. | | newsletter_report_delete_own | Delete own records for newsletter reports. | | newsletter_report_update | Update records for newsletter reports. | | newsletter_report_update_own | Update own records for newsletter reports. | | newsletter_report_view | View newsletter reports. | | newsletter_report_view_own | View own records for newsletter reports. | | newsletter_send | Send Newsletters. | | newsletter_view | View Newsletters. | | offers_add | Create new records for Offers. | | offers_add_notes | Add notes/activity log entries for Offers. | | offers_export | Export Offers. | | offers_reports | View/access offer reports. | | offers_reports_add | Create new records for offer reports. | | offers_reports_delete | Delete records for offer reports. | | offers_reports_delete_own | Delete own records for offer reports. | | offers_reports_update | Update records for offer reports. | | offers_reports_update_own | Update own records for offer reports. | | offers_reports_view | View offer reports. | | offers_reports_view_own | View own records for offer reports. | | offers_update | Update records for Offers. | | offers_update_own | Update own records for Offers. | | offers_view | View Offers. | | offers_view_notes | View notes/activity log entries for Offers. | | offers_view_own | View own records for Offers. | | profiles_add | Create new records for Profiles. | | profiles_add_notes | Add notes/activity log entries for Profiles. | | profiles_contacts_associated_agents_update | Update records for profiles' associated agents. | | profiles_contacts_associated_agents_view | View profiles' associated agents. | | profiles_delete | Delete records for Profiles. | | profiles_delete_own | Delete own records for Profiles. | | profiles_export | Export Profiles. | | profiles_reports | View/access profile reports. | | profiles_reports_add | Create new records for profile reports. | | profiles_reports_delete | Delete records for profile reports. | | profiles_reports_delete_own | Delete own records for profile reports. | | profiles_reports_update | Update records for profile reports. | | profiles_reports_update_own | Update own records for profile reports. | | profiles_reports_view | View profile reports. | | profiles_reports_view_own | View own records for profile reports. | | profiles_update | Update records for Profiles. | | profiles_update_own | Update own records for Profiles. | | profiles_view | View Profiles. | | profiles_view_notes | View notes/activity log entries for Profiles. | | profiles_view_own | View own records for Profiles. | | profiles_view_unassigned | View unassigned records for Profiles. | | races_add | Create new records for Races. | | referrals_add | Create new records for Referrals. | | referrals_add_notes | Add notes/activity log entries for Referrals. | | referrals_can_accept | Accept Referrals. | | referrals_can_add | Create Referrals. | | referrals_export | Export Referrals. | | referrals_reports | View/access referral reports. | | referrals_reports_add | Create new records for referral reports. | | referrals_reports_delete | Delete records for referral reports. | | referrals_reports_delete_own | Delete own records for referral reports. | | referrals_reports_update | Update records for referral reports. | | referrals_reports_update_own | Update own records for referral reports. | | referrals_reports_view | View referral reports. | | referrals_reports_view_own | View own records for referral reports. | | referrals_update | Update records for Referrals. | | referrals_update_own | Update own records for Referrals. | | referrals_view | View Referrals. | | referrals_view_notes | View notes/activity log entries for Referrals. | | referrals_view_own | View own records for Referrals. | | sales_targets_branch_edit | Edit branch sales targets. | | sales_targets_user_edit | Edit user sales targets. | | settings_update | Update records for Settings. | | settings_view | View Settings. | | snippets_add | Create new records for Snippets. | | snippets_delete | Delete records for Snippets. | | snippets_update | Update records for Snippets. | | statistics | View aggregated system statistics. | | super_access | Grants elevated (super user) access, bypassing standard branch/ownership restrictions. | | syndication_branches_can_sync | Allow syndication sync of branch syndication. | | syndication_listings_can_sync | Allow syndication sync of listing syndication. | | syndication_users_can_sync | Allow syndication sync of user syndication. | | tags_agency_add | Create new records for agency tags. | | tags_agency_delete | Delete records for agency tags. | | tags_agency_update | Update records for agency tags. | | tags_branch_add | Create new records for branch tags. | | tags_branch_delete | Delete records for branch tags. | | tags_branch_update | Update records for branch tags. | | tags_own_add | Create new records for own tags. | | tags_own_delete | Delete records for own tags. | | tags_own_update | Update records for own tags. | | teams_add | Create new records for Teams. | | teams_add_notes | Add notes/activity log entries for Teams. | | teams_delete | Delete records for Teams. | | teams_export | Export Teams. | | teams_reports | View/access team reports. | | teams_reports_add | Create new records for team reports. | | teams_reports_delete | Delete records for team reports. | | teams_reports_delete_own | Delete own records for team reports. | | teams_reports_update | Update records for team reports. | | teams_reports_update_own | Update own records for team reports. | | teams_reports_view | View team reports. | | teams_reports_view_own | View own records for team reports. | | teams_update | Update records for Teams. | | teams_view_notes | View notes/activity log entries for Teams. | | text_messages_export | Export Text messages. | | text_messages_report | View/access text message reports. | | text_messages_view | View Text messages. | | text_messages_view_own | View own records for Text messages. | | user_groups_add | Create new records for User groups. | | user_groups_delete | Delete records for User groups. | | user_groups_export | Export User groups. | | user_groups_update | Update records for User groups. | | user_groups_view | View User groups. | | user_personal_details_view | View users' personal (sensitive) details. | | users_add | Create new records for Users. | | users_add_notes | Add notes/activity log entries for Users. | | users_delete | Delete records for Users. | | users_email_stationery | Manage email stationery for Users. | | users_email_stationery_own | Manage own email stationery for Users. | | users_export | Export Users. | | users_reports_add | Create new records for user reports. | | users_reports_delete | Delete records for user reports. | | users_reports_delete_own | Delete own records for user reports. | | users_reports_update | Update records for user reports. | | users_reports_update_own | Update own records for user reports. | | users_reports_view | View user reports. | | users_reports_view_own | View own records for user reports. | | users_update | Update records for Users. | | users_update_own | Update own records for Users. | | users_update_scheduling | Update scheduling for Users. | | users_update_serviced_locations | Update serviced locations for Users. | | users_view_notes | View notes/activity log entries for Users. | | valuation_add | Create new records for Valuations. | | valuation_approve | Approve Valuations. | | valuation_delete | Delete records for Valuations. | | valuation_delete_own | Delete own records for Valuations. | | valuation_export | Export Valuations. | | valuation_reports | View/access valuation reports. | | valuation_reports_add | Create new records for valuation reports. | | valuation_reports_delete | Delete records for valuation reports. | | valuation_reports_delete_own | Delete own records for valuation reports. | | valuation_reports_update | Update records for valuation reports. | | valuation_reports_update_own | Update own records for valuation reports. | | valuation_reports_view | View valuation reports. | | valuation_reports_view_own | View own records for valuation reports. | | valuation_update | Update records for Valuations. | | valuation_update_own | Update own records for Valuations. | | valuation_view | View Valuations. | | valuation_view_own | View own records for Valuations. | | vehicles_add | Create new records for Vehicles. | | vehicles_delete | Delete records for Vehicles. | | vehicles_update | Update records for Vehicles. |

HTTP Request

POST/users/api/v1/groups/

Example Response

{
"id": 0,
"site": 0,
"permissions": [],
"created": "2026-09-08T14:40:49.352Z",
"modified": "2026-09-08T14:40:49.352Z",
"deleted": "2026-09-08T14:40:49.352Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"name": "string",
"active": false,
"statistics": 0
}

NameDescription

id

integer

ID

site

integer

Site

permissions

required

array of integers

Choices: [ 1,2,3...2147483648 ]

created

string

Created

modified

string

Modified

deleted

nullable

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref - A unique reference to use for linking records back to *your* system. NB: This must be unique across the entire Prop Data system, so it's best to use a consistent prefix unique to your integration to avoid conflicts with other api consumers.

name

required

string[ 1...100 ] characters

Name

active

boolean

Active

statistics

nullable

integer

Statistics

Responses

201
400 Bad request body
403 You do not have permission to perform this action
500 Internal server error
503 This website is not active