MasterRights.create
Creates a MasterRight record.
Request
- Base URLhttps://us-east.api.coevera.com/api/v100/rest/spaces/your_space_id
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
Request body
Last modification time.
Creation time.
Allows users with this role to manage account hierarchy types, account and contact relation types and account roles in Administration.
Shows the Accounts screen to users with this role. Which accounts they can see and edit is set by access_entity_account.
Allows users with this role to use the AI assistant that builds and describes automation processes, when the feature is enabled for the space.
Allows users with this role to use the AI assistant that creates online forms, when the feature is enabled for the space.
Allows users with this role to use AI summaries and suggested actions on record detail screens, when the feature is enabled for the space.
Allows users with this role to use AI to prefill new accounts, contacts and leads from an email, when the feature is enabled for the space.
Allows users with this role to use AI-suggested org charts and account hierarchies, when the feature is enabled for the space.
Allows users with this role to use the AI assistant that builds reports, when the feature is enabled for the space.
Allows users with this role to use AI smart fields, whose values are generated by AI, when the feature is enabled for the space.
Allows users with this role to publish appointment schedules that let others book meetings with them, when the feature is enabled for the space. Turning it off disables the schedules of the users with this role.
Allows users with this role to manage appointment schedules of other users.
Allows users with this role to create approval processes and manage their own, when approval processes are enabled for the space.
Allows users with this role to manage approval processes owned by other users.
Allows users with this role to open the Approvals screen and act on approval requests, when approval processes are enabled for the space.
Allows users with this role to open the Archive screens listing lost, closed and archived records.
Allows users with this role to open the Audit screen.
Allows users with this role to view the audit log of changes made in the space.
Whether users with this role may reorder and pin their own bottom menu ("Users can customize the bar"). Off by default: users get the layout set in bottom_menu_layout; a layout of their own (UISettings.bottom_menu_layout) is still stored but read as null until this is switched on.
Allows users with this role to update many records at once with bulk update.
Allows users with this role to make calls through the calling integration, when the feature is enabled for the space.
Which company phone numbers users with this role can use for calls and text messages: none (NoAccess), those in allowed_company_phones (Selected) or all (All).
Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All
Allows users with this role to purchase and manage company phone numbers for the calling integration.
Which shared company email accounts users with this role can send from: none (NoAccess), those in allowed_company_emails (Selected) or all (All).
Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All
Shows the Contacts screen to users with this role. Which contacts they can see and edit is set by access_entity_contact.
Allows users with this role to browse and work with documents in the Document Manager, when the feature is enabled for the space.
Allows users with this role to manage company documents and folders that are not tied to a record.
Allows users with this role to create and edit the document folders used for records.
Allows users with this role to use the duplicate checker to find duplicate records, when the feature is enabled for the space.
When true, users with this role get the email notification preferences from access_email_notification_settings and cannot change their own.
Default email notification preferences applied to users with this role (which events trigger an email and through which channel).
Level of access to accounts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the accounts the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing accounts.
Allows users with this role to delete accounts they can edit.
Which accounts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to own private accounts, which are visible only to their owner.
Allows users with this role to create new tags for accounts.
Whether users with this role can work with all account types (All) or only with those in allowed_account_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Level of access to appointments for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the appointments the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to delete appointments they can edit.
Which appointments users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to create new tags for appointments.
Whether users with this role can work with all appointment types (All) or only with those in allowed_appointment_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Level of access to Navigator screen layouts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to delete Navigator screen layouts owned by other users.
Allows users with this role to delete Navigator screen layouts they own.
Allows users with this role to share their Navigator screen layouts with selected users and sales units.
Allows users with this role to share their Navigator screen layouts with all users of the space.
Level of access to contacts for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the contacts the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing contacts.
Allows users with this role to delete contacts they can edit.
Which contacts users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to own private contacts, which are visible only to their owner.
Allows users with this role to create new tags for contacts.
Whether users with this role can work with all contact types (All) or only with those in allowed_contact_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Level of access to dashboards for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All). Dashboards are unavailable while access_entity_report is NoAccess.
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to delete dashboards owned by other users.
Allows users with this role to delete dashboards they own.
Allows users with this role to share their dashboards with selected users and sales units.
Allows users with this role to share their dashboards with all users of the space.
Which emails users with this role see on records, reports, feeds and automation. Default: any email linked to a record the user can see. UsersAndSalesUnits: only emails owned by or shared by users / sales unit members in access_entity_email_allowed (own and shared-with-me emails always stay visible). The Inbox is not affected.
Integer enum value: 0 - Default, 1 - UsersAndSalesUnits
Allow-list for access_entity_email_access_level = UsersAndSalesUnits: users and sales units (their Member users) whose emails stay visible. Kept when switching back to Default.
How users with this role can share the body of their emails: always private (PrivateOnly), always public (PublicOnly) or chosen per email (Custom).
Integer enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly
Allows users with this role to delete emails they neither own nor sent.
Whether the email integration of users with this role links emails to the accounts of their recipients. Custom leaves it to each user's own email settings.
Integer enum value: 0 - Custom, 1 - On, 2 - Off
Whether the email integration of users with this role links emails to accounts whose website domain matches a recipient's email domain. Custom leaves it to each user's own email settings.
Integer enum value: 0 - Custom, 1 - On, 2 - Off
Whether the email integration of users with this role links emails to the contacts of their recipients. Custom leaves it to each user's own email settings.
Integer enum value: 0 - Custom, 1 - On, 2 - Off
Level of access to email sequences for users with this role, when email sequences are enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess
Level of access to email templates for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to create and delete email template folders.
Allows users with this role to delete email templates owned by other users.
Allows users with this role to delete email templates they own.
Allows users with this role to share their email templates with selected users and sales units.
Allows users with this role to share their email templates with all users of the space.
Level of access to forecasts for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to delete forecasts owned by other users.
Allows users with this role to delete forecasts they own.
Allows users with this role to edit forecasts owned by other users.
Allows users with this role to share their forecasts with selected users and sales units.
Allows users with this role to share their forecasts with all users of the space.
Level of access to form views for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to delete form views owned by other users.
Allows users with this role to delete form views they own.
Allows users with this role to share their form views with selected users and sales units.
Allows users with this role to share their form views with all users of the space.
Level of access to leads for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the leads the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing leads.
Allows users with this role to delete leads they can edit.
Which leads users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to own private leads, which are visible only to their owner.
Allows users with this role to create new tags for leads.
Whether users with this role can work with all lead types (All) or only with those in allowed_lead_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Allows users with this role to create new tags for emails, memos and text messages.
Level of access to opportunities for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the opportunities the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing opportunities.
Allows users with this role to delete opportunities they can edit.
Which opportunities users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to own private opportunities, which are visible only to their owner.
Allows users with this role to create new tags for opportunities.
Which pipelines users with this role can work with: none (NoPipeline), those in allowed_pipelines (Selected), or all with or without access to pipeline step documents (AllWithDocuments, AllNoDocuments).
Integer enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments
Level of access to automation processes for users with this role, when process automation is enabled for the space: none (NoAccess), only their own (Personal) or all (FullAccess).
Integer enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess
Level of access to screen profiles (saved screen views) for users with this role: use of those shared with them (Readonly) or also creating their own (All). NoAccess is rejected.
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.).
Allows users with this role to delete screen profiles owned by other users.
Allows users with this role to delete screen profiles they own.
Allows users with this role to share their screen profiles with selected users and sales units.
Allows users with this role to share their screen profiles with all users of the space.
Level of access to projects for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the projects the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing projects.
Allows users with this role to delete projects they can edit.
Which projects users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to own private projects, which are visible only to their owner.
Allows users with this role to create new tags for projects.
Level of access to quotes for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the quotes the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to create copies of existing quotes.
Allows users with this role to delete quotes they can edit.
Which quotes users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to create new tags for quotes.
Whether users with this role can work with all quote types (All) or only with those in allowed_quote_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Level of access to reports for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to create and delete report folders.
Allows users with this role to delete reports owned by other users.
Allows users with this role to delete reports they own.
Allows users with this role to save reports as private, visible only to themselves.
Allows users with this role to schedule reports for regular delivery.
Allows users with this role to view and manage report schedules of other users.
Allows users with this role to share their reports with selected users and sales units.
Allows users with this role to share their reports with all users of the space.
Allows users with this role to view and follow solutions, when the feature is enabled for the space.
Allows users with this role to create, edit and delete solutions.
Level of access to targets for users with this role: not available (NoAccess), use of those shared with them (Readonly), or also creating their own (All).
Integer enum value: 0 - NoAccess, 1 - Readonly, 4 - All
Allows users with this role to delete targets owned by other users.
Allows users with this role to delete targets they own.
Level of access to tasks for users with this role, from NoAccess and Readonly to Editor, EditorOrUnitManger and All. Applies to the tasks the role can see.
Integer enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All
Allows users with this role to delete tasks they can edit.
Which tasks users with this role can see besides those they own or that are shared with them: no others (Owned), those of their sales units (Current and its variants) or all (All).
Integer enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All
Allows users with this role to create new tags for tasks.
Whether users with this role can work with all task types (All) or only with those in allowed_task_types (Selected).
Integer enum value: 1 - All, 2 - Selected
Allows users with this role to create tasks without an owner (unassigned tasks).
Allows users with this role to export records and reports to files.
Allows users with this role to open the Feed screen with the stream of activities, emails and other updates.
Allows users with this role to manage currencies and exchange rate lists in Administration.
Allows users with this role to manage fields, forms, record types, tags and translations in Administration.
Allows users with this role to manage the global settings of the space in Administration, including the Automation Hub and API access.
Allows users with this role to open the Navigator screen.
Allows users with this role to import records from files.
Allows users with this role to open the Insights area with sales performance, indicator, conversion and lifecycle overviews.
Shows the Leads screen to users with this role. Which leads they can see and edit is set by access_entity_lead.
Allows users with this role to create online forms and manage their own, when online forms are enabled for the space.
Allows users with this role to edit and delete online forms owned by other users.
Shows the Opportunities screen to users with this role. Which opportunities they can see and edit is set by access_entity_oppty.
Allows users with this role to manage pipelines, lead processes and quote processes in Administration.
Allows users with this role to print records and reports.
Allows users with this role to manage products, product categories and price lists in Administration.
Allows users with this role to use Projects, when the feature is enabled for the space. Which projects they can see and edit is set by access_entity_project.
Allows users with this role to use Quotes, when the feature is enabled for the space. Which quotes they can see and edit is set by access_entity_quote.
Allows users with this role to manage sales roles in Administration.
Allows users with this role to manage the security settings of the space in Administration.
Allows users with this role to manage sales units in Administration.
Allows users with this role to manage users, user roles and sales unit membership in Administration. Cannot be turned off on the default administrator role.
Which company phone numbers users with this role can use for WhatsApp messages, when WhatsApp is enabled for the space: none (NoAccess), those in allowed_company_phones (Selected) or all (All).
Integer enum value: 0 - NoAccess, 1 - Selected, 2 - All
The role's Navigation list as one tree: top-level rows in the role's default bottom menu order, where a group row (kind Section: Communication, Analytics, Archive, Tools or a custom section) carries its member items. Stored as the client sent it; until it is saved once the default list is returned, everything enabled and pinned. The access_* flags of the role are not touched by it: the client sends both.
Name of the entity and its default text representation.
Revision when entity was lastly changed.
Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space.
Example request
{
"modified": "2019-01-01T00:00:00",
"created": "2019-01-01T00:00:00",
"access_entity_account_direction": 1,
"access_entity_account_types": 1,
"access_entity_appointment_direction": 1,
"access_entity_appointment_types": 1,
"access_entity_contact_direction": 1,
"access_entity_contact_types": 1,
"access_entity_email_sequence": 1,
"access_entity_lead_direction": 1,
"access_entity_lead_types": 1,
"access_entity_oppty_direction": 1,
"access_entity_process": 1,
"access_entity_project_direction": 1,
"access_entity_quote_direction": 1,
"access_entity_quote_types": 1,
"access_entity_task_direction": 1,
"access_entity_task_types": 1,
"name": "string",
"revision": 1,
"custom_entities": "blob"
}Response
The created MasterRight record.
True when the request succeeded; false on error.
Example response
{
"success": true,
"data": {
"id": "01234567-abcd-dcba-ffff-000000000000",
"modified": "2019-01-01T00:00:00",
"created": "2019-01-01T00:00:00",
"access_entity_account_direction": 1,
"access_entity_account_types": 1,
"access_entity_appointment_direction": 1,
"access_entity_appointment_types": 1,
"access_entity_contact_direction": 1,
"access_entity_contact_types": 1,
"access_entity_email_sequence": 1,
"access_entity_lead_direction": 1,
"access_entity_lead_types": 1,
"access_entity_oppty_direction": 1,
"access_entity_process": 1,
"access_entity_project_direction": 1,
"access_entity_quote_direction": 1,
"access_entity_quote_types": 1,
"access_entity_task_direction": 1,
"access_entity_task_types": 1,
"name": "string",
"revision": 1,
"custom_entities": "blob"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.