API Reference

referral.create

post
https://api.ashbyhq.com/referral.create

Creates a referral

Requires the candidatesWrite permission.

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

The id of the referral form, from /referralForm.info

uuid
required

The id of the user submitting the referral

fieldSubmissions
array of objects
required

The field submissions for the referral form

fieldSubmissions*

An ISO date string to set the referral's createdAt timestamp to. When this value isn't provided, the createdAt timestamp defaults to the time the referral was created.

Response

Updated about 1 month ago

Language
Credentials
Basic
base64
:
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