GuidesRecipesAPI Reference
Log In
API Reference

🚧 Perform action on a role (BETA)

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

Under construction

This endpoint is in beta. Functionality may change without notice, support is limited, and use in production is not recommended. Your feedback is appreciated.

This endpoint will perform an action on a role record.

đź“Ś

Available actions

DUPLICATE - Duplicate a role

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

Role ID

Body Params

Available properties for a role action.

string
enum
required

Action to perform.

Allowed:
string

The new role's name. Defaults to the source role's name with " (Copy)" appended.

string

The new role's description. Defaults to the source role's description.

Headers
string

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

Responses

Updated about 1 month 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 about 1 month ago

Did this page help you?