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

post

https://api.ncinomortgage.com/users/loan_officers/{loan_officer_id}/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,
and records the recipient as one of the loan officer's prospects.
Set share_type to LEAD_GEN to send the lead generation form link instead.
When a partner_id is supplied, the share is co-branded with the partner.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

loan_officer_id

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.
The recipient is recorded as a prospect of the loan officer.

string | null

Email address to send the app link to.

phone

string | null

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

destination_name

string | null

Recipient's name, used to personalize the email. Defaults to first_name.

first_name

string | null

Recipient's first name, saved on the prospect.

last_name

string | null

Recipient's last name, saved on the prospect.

share_type

string | null

enum

What to share: the app sign-up link (APP, the default) or the lead generation form link (LEAD_GEN).

Allowed:

partner_id

uuid | null

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

Headers

X-Api-Version

string

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

Responses

204App link shared

400Invalid request body

401Unauthorized

403Forbidden

404Not found

412Lead generation form is not enabled for this loan officer

500Internal server error