GuidesRecipesAPI Reference
Log In
API Reference

🚧 Share a loan officer's app link (BETA)

post
https://api.ncinomortgage.com/users/loan_officers//app_shares
🚧

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 shares a loan officer's app link with a recipient by email and/or SMS.
When a partner_id is supplied, the share is co-branded with the partner.

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

Loan officer ID.

Body Params

Available properties for sharing a loan officer's app link. At least one of email or phone must be supplied.

string | null

Email address to send the app link to.

string | null

Phone number to send the app link to. Formatting characters are stripped; must resolve to 10 digits.

string | null

Recipient's name, used to personalize the email.

uuid | null

Partner ID. When supplied, the share is co-branded with the partner.

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?