Skip to main content
PUT
Replace the partner policy

Authorizations

Authorization
string
header
required

One client per partner per environment. Access tokens expire after 15 minutes. Scopes are granted per client. Sandbox clients use https://sandbox.api.meet-oj.com/oauth/token.

Body

application/json

The rules O.J. follows for your referrals. Read it to know how your account behaves. Replace it to change that. Every field has a default, so an empty policy is a working policy.

require_send_approval
boolean
default:false

When true, each lender submission waits for a person at your company. It arrives in todos as an approve_send item for your team, and the referral is needs_partner until someone approves. Lenders running a program on O.J. usually set this.

allowed_origins
string[]

Web origins that may open O.J. Embed. localhost is always allowed in the sandbox.

Example:
contact_channels
enum<string>[]

Which of O.J.'s own channels may contact your borrowers. An empty list means O.J. only reaches them through your product: Embed, hosted pages you link to, or your channel connectors.

Available options:
sms,
imessage,
email,
voice
default_intent
enum<string>

Who the borrower hears from. O.J. does the work either way. With just_refer, O.J. contacts the borrower directly, introducing itself as working with you, and sends the borrower the link for each to-do. With work_this_deal, O.J. never contacts the borrower; each to-do arrives in the referral's todos with a link you place in your own product, so the borrower acts inside your flow.

Available options:
work_this_deal,
just_refer
reminders
object
next_action_ttl_days
integer
default:7

How long a next action's hosted link stays valid without being read.

Response

The policy as saved

The rules O.J. follows for your referrals. Read it to know how your account behaves. Replace it to change that. Every field has a default, so an empty policy is a working policy.

require_send_approval
boolean
default:false

When true, each lender submission waits for a person at your company. It arrives in todos as an approve_send item for your team, and the referral is needs_partner until someone approves. Lenders running a program on O.J. usually set this.

allowed_origins
string[]

Web origins that may open O.J. Embed. localhost is always allowed in the sandbox.

Example:
contact_channels
enum<string>[]

Which of O.J.'s own channels may contact your borrowers. An empty list means O.J. only reaches them through your product: Embed, hosted pages you link to, or your channel connectors.

Available options:
sms,
imessage,
email,
voice
default_intent
enum<string>

Who the borrower hears from. O.J. does the work either way. With just_refer, O.J. contacts the borrower directly, introducing itself as working with you, and sends the borrower the link for each to-do. With work_this_deal, O.J. never contacts the borrower; each to-do arrives in the referral's todos with a link you place in your own product, so the borrower acts inside your flow.

Available options:
work_this_deal,
just_refer
reminders
object
next_action_ttl_days
integer
default:7

How long a next action's hosted link stays valid without being read.

updated_at
string<date-time>
read-only