Skip to main content
POST
Add job referral partner

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Job UUID

Body

application/json
client_contact_id
string<uuid>
required

Client contact UUID to add as a referral partner. Any live client contact in your workspace can be added, from any company. Find IDs with GET /v1/client-contacts?keywords=...

default_split_percentage
number | null

Default percentage offered to this partner when a placement is logged on the job. More than 0 and at most 100, rounded to 2 decimals. Null when no default is set.

default_mode
enum<string>

How the partner is paid on placements by default. Defaults to off_the_top.

Available options:
off_the_top,
team_pool

Response

Referral partner added

success
enum<boolean>
required
Available options:
true
data
object
required