Create User Group

HTTP Request

POSThttps://staging.api-gw.propdata.net/users/api/v1/groups/

Example Response

{
"id": 0,
"site": 0,
"created": "2021-03-01T14:10:07.551Z",
"modified": "2021-03-01T14:10:07.551Z",
"deleted": "2021-03-01T14:10:07.551Z",
"uuid": "770bba28-9f80-4d40-9c51-6e022364af91",
"source_ref": "string",
"name": "string",
"active": false,
"apply_to_all_branches": false,
"super_access": false,
"branches_add": false,
"branches_update": false,
"teams_add": false,
"teams_update": false,
"leads_view": false,
"leads_add": false,
"leads_update": false,
"leads_archive": false,
"listings_residential_for_sale_view": false,
"listings_residential_for_sale_add": false,
"listings_residential_for_sale_update": false,
"listings_residential_for_sale_can_select_featured": false,
"listings_residential_for_sale_select_newsletter_featured": false,
"listings_residential_for_sale_select_agent_newsletter_featured": false,
"listings_residential_to_let_view": false,
"listings_residential_to_let_add": false,
"listings_residential_to_let_update": false,
"listings_residential_to_let_can_select_featured": false,
"listings_residential_to_let_select_newsletter_featured": false,
"listings_residential_to_let_select_agent_newsletter_featured": false,
"listings_residential_for_sale_feed_to_portals": false,
"listings_residential_to_let_feed_to_portals": false,
"listings_commercial_for_sale_view": false,
"listings_commercial_for_sale_add": false,
"listings_commercial_for_sale_update": false,
"listings_commercial_for_sale_can_select_featured": false,
"listings_commercial_for_sale_select_newsletter_featured": false,
"listings_commercial_for_sale_select_agent_newsletter_featured": false,
"listings_commercial_to_let_view": false,
"listings_commercial_to_let_add": false,
"listings_commercial_to_let_update": false,
"listings_commercial_to_let_can_select_featured": false,
"listings_commercial_to_let_select_newsletter_featured": false,
"listings_commercial_to_let_select_agent_newsletter_featured": false,
"listings_commercial_for_sale_feed_to_portals": false,
"listings_commercial_to_let_feed_to_portals": false,
"listings_holiday_view": false,
"listings_holiday_add": false,
"listings_holiday_update": false,
"listings_holiday_can_select_featured": false,
"listings_holiday_select_newsletter_featured": false,
"listings_holiday_select_agent_newsletter_featured": false,
"listings_holiday_feed_to_portals": false,
"listings_projects_view": false,
"listings_projects_add": false,
"listings_projects_update": false,
"listings_projects_can_select_featured": false,
"listings_projects_select_newsletter_featured": false,
"listings_projects_select_agent_newsletter_featured": false,
"settings_view": false,
"settings_update": false,
"user_groups_view": false,
"user_groups_add": false,
"user_groups_update": false,
"users_add": false,
"users_update": false,
"user_personal_details_view": false,
"designations_add": false,
"races_add": false,
"users_email_stationery": false,
"location_profiles_view": false,
"location_profiles_add": false,
"location_profiles_update": false,
"cms_view": false,
"cms_add": false,
"cms_update": false,
"news_view": false,
"news_add": false,
"news_categories_add": false,
"news_update": false,
"newsletter_send": false,
"newsletter_view": false,
"offers_view": false,
"mailing_list_add": false,
"mailing_list_update": false,
"mailing_list_view": false,
"contacts_view": false,
"contacts_add": false,
"contacts_update": false,
"contact_types_add": false,
"profiles_view": false,
"profiles_add": false,
"profiles_update": false,
"documents_add": false,
"documents_delete": false,
"documents_update": false,
"branches_view_notes": false,
"branches_add_notes": false,
"branches_export": false,
"branches_reports": false,
"branches_update_serviced_locations": false,
"users_update_own": false,
"users_email_stationery_own": false,
"users_reports": false,
"users_view_notes": false,
"users_add_notes": false,
"users_export": false,
"teams_view_notes": false,
"teams_add_notes": false,
"teams_reports": false,
"teams_export": false,
"user_groups_export": false,
"listings_residential_for_sale_view_own": false,
"listings_residential_for_sale_update_own": false,
"listings_residential_to_let_view_own": false,
"listings_residential_to_let_update_own": false,
"listings_residential_view_notes": false,
"listings_residential_add_notes": false,
"listings_residential_for_sale_export": false,
"listings_residential_to_let_export": false,
"listings_residential_for_sale_reports": false,
"listings_residential_to_let_reports": false,
"listings_residential_for_sale_view_team": false,
"listings_residential_for_sale_update_team": false,
"listings_residential_to_let_view_team": false,
"listings_residential_to_let_update_team": false,
"listings_residential_for_sale_display_on_website": false,
"listings_residential_to_let_display_on_website": false,
"listings_commercial_for_sale_view_own": false,
"listings_commercial_for_sale_update_own": false,
"listings_commercial_to_let_view_own": false,
"listings_commercial_to_let_update_own": false,
"listings_commercial_view_notes": false,
"listings_commercial_add_notes": false,
"listings_commercial_for_sale_reports": false,
"listings_commercial_to_let_reports": false,
"listings_commercial_for_sale_export": false,
"listings_commercial_to_let_export": false,
"listings_commercial_for_sale_update_team": false,
"listings_commercial_for_sale_view_team": false,
"listings_commercial_to_let_update_team": false,
"listings_commercial_to_let_view_team": false,
"listings_commercial_for_sale_display_on_website": false,
"listings_commercial_to_let_display_on_website": false,
"listings_projects_view_own": false,
"listings_projects_update_own": false,
"listings_projects_view_notes": false,
"listings_projects_add_notes": false,
"listings_projects_export": false,
"listings_projects_reports": false,
"listings_projects_view_team": false,
"listings_projects_update_team": false,
"listings_projects_display_on_website": false,
"listings_holiday_view_own": false,
"listings_holiday_update_own": false,
"listings_holiday_view_notes": false,
"listings_holiday_add_notes": false,
"listings_holiday_export": false,
"listings_holiday_reports": false,
"listings_holiday_view_team": false,
"listings_holiday_update_team": false,
"listings_holiday_display_on_website": false,
"contacts_view_own": false,
"contacts_update_own": false,
"contacts_associated_agents_view": false,
"contacts_associated_agents_update": false,
"contacts_view_notes": false,
"contacts_add_notes": false,
"contacts_view_team": false,
"contacts_update_team": false,
"contacts_export": false,
"contacts_reports": false,
"leads_view_own": false,
"leads_update_own": false,
"leads_contacts_associated_agents_view": false,
"leads_contacts_associated_agents_update": false,
"leads_view_notes": false,
"leads_add_notes": false,
"leads_view_team": false,
"leads_update_team": false,
"leads_export": false,
"leads_reports": false,
"leads_sms_report": false,
"profiles_view_own": false,
"profiles_update_own": false,
"profiles_contacts_associated_agents_view": false,
"profiles_contacts_associated_agents_update": false,
"profiles_view_notes": false,
"profiles_add_notes": false,
"profiles_export": false,
"profiles_reports": false,
"mailing_list_update_own": false,
"mailing_list_view_own": false,
"mailing_list_contacts_associated_agents_view": false,
"mailing_list_contacts_associated_agents_update": false,
"mailing_list_view_notes": false,
"mailing_list_add_notes": false,
"mailing_list_import": false,
"mailing_list_export": false,
"mailing_list_reports": false,
"syndication_listings_can_sync": false,
"syndication_branches_can_sync": false,
"syndication_users_can_sync": false,
"documents_export": false,
"documents_view_notes": false,
"documents_add_notes": false,
"cms_export": false,
"cms_view_notes": false,
"cms_add_notes": false,
"news_export": false,
"news_view_notes": false,
"news_add_notes": false,
"insights_view": false,
"offers_view_own": false,
"newsletter_report": false,
"location_profiles_export": false,
"statistics": 0
}

NameDescription

id

integer

ID

site

integer

Site

created

string

Created

modified

string

Modified

deleted

string

Deleted

uuid

string

Uuid

source_ref

nullable

string<= 100 characters

Source ref

name

nullable

string<= 100 characters

Name

active

boolean

Active

apply_to_all_branches

boolean

Apply to all branches

super_access

boolean

Super access

branches_add

boolean

Branches add

branches_update

boolean

Branches update

teams_add

boolean

Teams add

teams_update

boolean

Teams update

leads_view

boolean

Leads view

leads_add

boolean

Leads add

leads_update

boolean

Leads update

leads_archive

boolean

Leads archive

listings_residential_for_sale_view

boolean

Listings residential for sale view

listings_residential_for_sale_add

boolean

Listings residential for sale add

listings_residential_for_sale_update

boolean

Listings residential for sale update

listings_residential_for_sale_can_select_featured

boolean

Listings residential for sale can select featured

listings_residential_for_sale_select_newsletter_featured

boolean

Listings residential for sale select newsletter featured

listings_residential_for_sale_select_agent_newsletter_featured

boolean

Listings residential for sale select agent newsletter featured

listings_residential_to_let_view

boolean

Listings residential to let view

listings_residential_to_let_add

boolean

Listings residential to let add

listings_residential_to_let_update

boolean

Listings residential to let update

listings_residential_to_let_can_select_featured

boolean

Listings residential to let can select featured

listings_residential_to_let_select_newsletter_featured

boolean

Listings residential to let select newsletter featured

listings_residential_to_let_select_agent_newsletter_featured

boolean

Listings residential to let select agent newsletter featured

listings_residential_for_sale_feed_to_portals

boolean

Listings residential for sale feed to portals

listings_residential_to_let_feed_to_portals

boolean

Listings residential to let feed to portals

listings_commercial_for_sale_view

boolean

Listings commercial for sale view

listings_commercial_for_sale_add

boolean

Listings commercial for sale add

listings_commercial_for_sale_update

boolean

Listings commercial for sale update

listings_commercial_for_sale_can_select_featured

boolean

Listings commercial for sale can select featured

listings_commercial_for_sale_select_newsletter_featured

boolean

Listings commercial for sale select newsletter featured

listings_commercial_for_sale_select_agent_newsletter_featured

boolean

Listings commercial for sale select agent newsletter featured

listings_commercial_to_let_view

boolean

Listings commercial to let view

listings_commercial_to_let_add

boolean

Listings commercial to let add

listings_commercial_to_let_update

boolean

Listings commercial to let update

listings_commercial_to_let_can_select_featured

boolean

Listings commercial to let can select featured

listings_commercial_to_let_select_newsletter_featured

boolean

Listings commercial to let select newsletter featured

listings_commercial_to_let_select_agent_newsletter_featured

boolean

Listings commercial to let select agent newsletter featured

listings_commercial_for_sale_feed_to_portals

boolean

Listings commercial for sale feed to portals

listings_commercial_to_let_feed_to_portals

boolean

Listings commercial to let feed to portals

listings_holiday_view

boolean

Listings holiday view

listings_holiday_add

boolean

Listings holiday add

listings_holiday_update

boolean

Listings holiday update

listings_holiday_can_select_featured

boolean

Listings holiday can select featured

listings_holiday_select_newsletter_featured

boolean

Listings holiday select newsletter featured

listings_holiday_select_agent_newsletter_featured

boolean

Listings holiday select agent newsletter featured

listings_holiday_feed_to_portals

boolean

Listings holiday feed to portals

listings_projects_view

boolean

Listings projects view

listings_projects_add

boolean

Listings projects add

listings_projects_update

boolean

Listings projects update

listings_projects_can_select_featured

boolean

Listings projects can select featured

listings_projects_select_newsletter_featured

boolean

Listings projects select newsletter featured

listings_projects_select_agent_newsletter_featured

boolean

Listings projects select agent newsletter featured

settings_view

boolean

Settings view

settings_update

boolean

Settings update

user_groups_view

boolean

User groups view

user_groups_add

boolean

User groups add

user_groups_update

boolean

User groups update

users_add

boolean

Users add

users_update

boolean

Users update

user_personal_details_view

boolean

User personal details view

designations_add

boolean

Designations add

races_add

boolean

Races add

users_email_stationery

boolean

Users email stationery

location_profiles_view

boolean

Location profiles view

location_profiles_add

boolean

Location profiles add

location_profiles_update

boolean

Location profiles update

cms_view

boolean

Cms view

cms_add

boolean

Cms add

cms_update

boolean

Cms update

news_view

boolean

News view

news_add

boolean

News add

news_categories_add

boolean

News categories add

news_update

boolean

News update

newsletter_send

boolean

Newsletter send

newsletter_view

boolean

Newsletter view

offers_view

boolean

Offers view

mailing_list_add

boolean

Mailing list add

mailing_list_update

boolean

Mailing list update

mailing_list_view

boolean

Mailing list view

contacts_view

boolean

Contacts view

contacts_add

boolean

Contacts add

contacts_update

boolean

Contacts update

contact_types_add

boolean

Contact types add

profiles_view

boolean

Profiles view

profiles_add

boolean

Profiles add

profiles_update

boolean

Profiles update

documents_add

boolean

Documents add

documents_delete

boolean

Documents delete

documents_update

boolean

Documents update

branches_view_notes

boolean

Branches view notes

branches_add_notes

boolean

Branches add notes

branches_export

boolean

Branches export

branches_reports

boolean

Branches reports

branches_update_serviced_locations

boolean

Branches update serviced locations

users_update_own

boolean

Users update own

users_email_stationery_own

boolean

Users email stationery own

users_reports

boolean

Users reports

users_view_notes

boolean

Users view notes

users_add_notes

boolean

Users add notes

users_export

boolean

Users export

teams_view_notes

boolean

Teams view notes

teams_add_notes

boolean

Teams add notes

teams_reports

boolean

Teams reports

teams_export

boolean

Teams export

user_groups_export

boolean

User groups export

listings_residential_for_sale_view_own

boolean

Listings residential for sale view own

listings_residential_for_sale_update_own

boolean

Listings residential for sale update own

listings_residential_to_let_view_own

boolean

Listings residential to let view own

listings_residential_to_let_update_own

boolean

Listings residential to let update own

listings_residential_view_notes

boolean

Listings residential view notes

listings_residential_add_notes

boolean

Listings residential add notes

listings_residential_for_sale_export

boolean

Listings residential for sale export

listings_residential_to_let_export

boolean

Listings residential to let export

listings_residential_for_sale_reports

boolean

Listings residential for sale reports

listings_residential_to_let_reports

boolean

Listings residential to let reports

listings_residential_for_sale_view_team

boolean

Listings residential for sale view team

listings_residential_for_sale_update_team

boolean

Listings residential for sale update team

listings_residential_to_let_view_team

boolean

Listings residential to let view team

listings_residential_to_let_update_team

boolean

Listings residential to let update team

listings_residential_for_sale_display_on_website

boolean

Listings residential for sale display on website

listings_residential_to_let_display_on_website

boolean

Listings residential to let display on website

listings_commercial_for_sale_view_own

boolean

Listings commercial for sale view own

listings_commercial_for_sale_update_own

boolean

Listings commercial for sale update own

listings_commercial_to_let_view_own

boolean

Listings commercial to let view own

listings_commercial_to_let_update_own

boolean

Listings commercial to let update own

listings_commercial_view_notes

boolean

Listings commercial view notes

listings_commercial_add_notes

boolean

Listings commercial add notes

listings_commercial_for_sale_reports

boolean

Listings commercial for sale reports

listings_commercial_to_let_reports

boolean

Listings commercial to let reports

listings_commercial_for_sale_export

boolean

Listings commercial for sale export

listings_commercial_to_let_export

boolean

Listings commercial to let export

listings_commercial_for_sale_update_team

boolean

Listings commercial for sale update team

listings_commercial_for_sale_view_team

boolean

Listings commercial for sale view team

listings_commercial_to_let_update_team

boolean

Listings commercial to let update team

listings_commercial_to_let_view_team

boolean

Listings commercial to let view team

listings_commercial_for_sale_display_on_website

boolean

Listings commercial for sale display on website

listings_commercial_to_let_display_on_website

boolean

Listings commercial to let display on website

listings_projects_view_own

boolean

Listings projects view own

listings_projects_update_own

boolean

Listings projects update own

listings_projects_view_notes

boolean

Listings projects view notes

listings_projects_add_notes

boolean

Listings projects add notes

listings_projects_export

boolean

Listings projects export

listings_projects_reports

boolean

Listings projects reports

listings_projects_view_team

boolean

Listings projects view team

listings_projects_update_team

boolean

Listings projects update team

listings_projects_display_on_website

boolean

Listings projects display on website

listings_holiday_view_own

boolean

Listings holiday view own

listings_holiday_update_own

boolean

Listings holiday update own

listings_holiday_view_notes

boolean

Listings holiday view notes

listings_holiday_add_notes

boolean

Listings holiday add notes

listings_holiday_export

boolean

Listings holiday export

listings_holiday_reports

boolean

Listings holiday reports

listings_holiday_view_team

boolean

Listings holiday view team

listings_holiday_update_team

boolean

Listings holiday update team

listings_holiday_display_on_website

boolean

Listings holiday display on website

contacts_view_own

boolean

Contacts view own

contacts_update_own

boolean

Contacts update own

contacts_associated_agents_view

boolean

Contacts associated agents view

contacts_associated_agents_update

boolean

Contacts associated agents update

contacts_view_notes

boolean

Contacts view notes

contacts_add_notes

boolean

Contacts add notes

contacts_view_team

boolean

Contacts view team

contacts_update_team

boolean

Contacts update team

contacts_export

boolean

Contacts export

contacts_reports

boolean

Contacts reports

leads_view_own

boolean

Leads view own

leads_update_own

boolean

Leads update own

leads_contacts_associated_agents_view

boolean

Leads contacts associated agents view

leads_contacts_associated_agents_update

boolean

Leads contacts associated agents update

leads_view_notes

boolean

Leads view notes

leads_add_notes

boolean

Leads add notes

leads_view_team

boolean

Leads view team

leads_update_team

boolean

Leads update team

leads_export

boolean

Leads export

leads_reports

boolean

Leads reports

leads_sms_report

boolean

Leads sms report

profiles_view_own

boolean

Profiles view own

profiles_update_own

boolean

Profiles update own

profiles_contacts_associated_agents_view

boolean

Profiles contacts associated agents view

profiles_contacts_associated_agents_update

boolean

Profiles contacts associated agents update

profiles_view_notes

boolean

Profiles view notes

profiles_add_notes

boolean

Profiles add notes

profiles_export

boolean

Profiles export

profiles_reports

boolean

Profiles reports

mailing_list_update_own

boolean

Mailing list update own

mailing_list_view_own

boolean

Mailing list view own

mailing_list_contacts_associated_agents_view

boolean

Mailing list contacts associated agents view

mailing_list_contacts_associated_agents_update

boolean

Mailing list contacts associated agents update

mailing_list_view_notes

boolean

Mailing list view notes

mailing_list_add_notes

boolean

Mailing list add notes

mailing_list_import

boolean

Mailing list import

mailing_list_export

boolean

Mailing list export

mailing_list_reports

boolean

Mailing list reports

syndication_listings_can_sync

boolean

Syndication listings can sync

syndication_branches_can_sync

boolean

Syndication branches can sync

syndication_users_can_sync

boolean

Syndication users can sync

documents_export

boolean

Documents export

documents_view_notes

boolean

Documents view notes

documents_add_notes

boolean

Documents add notes

cms_export

boolean

Cms export

cms_view_notes

boolean

Cms view notes

cms_add_notes

boolean

Cms add notes

news_export

boolean

News export

news_view_notes

boolean

News view notes

news_add_notes

boolean

News add notes

insights_view

boolean

Insights view

offers_view_own

boolean

Offers view own

newsletter_report

boolean

Newsletter report

location_profiles_export

boolean

Location profiles export

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