GuidesRecipesAPI Reference
Log In
API Reference

Create a role record

post
https://api.ncinomortgage.com/roles

Create a role record

A role must have at least one permission. Supply either a
template or a non-empty list of permission_keys, but not both.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The available properties for creating a role record.

string
required

The role's name.

string

The role's description.

string
enum

Pre-populate the role with permissions from this template. Cannot be combined with permission_keys.

Allowed:
permission_keys
array of strings
length ≥ 1

Permission keys to enable on the role. Cannot be combined with template.

permission_keys
Headers
string

Specify API version, for example '1.0'. By default, the version configured in the company settings is used.

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?