Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Referral

referral.create

Creates a referral

Requires the candidatesWrite permission.

post/referral.create

Request body

idstring uuid required

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

creditedToUserIdstring uuid required

The id of the user submitting the referral

createdAtstring date-time nullable

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.

Example request

{
  "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "creditedToUserId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "createdAt": "2022-08-12T20:29:56.964Z"
}

Response

Responses from the referral.create endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "createdAt": "2026-04-25T02:46:41.817Z",
    "updatedAt": "2026-04-25T02:46:46.230Z",
    "status": "Active",
    "customFields": [],
    "candidate": {
      "id": "84bfbed7-ed0a-496d-bb18-11b73369f666",
      "name": "Michael Bluth",
      "primaryEmailAddress": {
        "value": "michael@bluth.example",
        "type": "Personal",
        "isPrimary": true
      },
      "primaryPhoneNumber": null
    },
    "currentInterviewStage": {
      "id": "c153b3e9-8b97-4fc0-bad1-6c654122c1f8",
      "title": "Application Review",
      "type": "PreInterviewScreen",
      "orderInInterviewPlan": 1,
      "interviewStageGroupId": null,
      "interviewPlanId": "d3f4762e-1234-4abc-9876-aabbccddeeff"
    },
    "source": null,
    "archiveReason": null,
    "archivedAt": null,
    "job": {
      "id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
      "title": "First Designer",
      "locationId": null,
      "departmentId": null
    },
    "creditedToUser": {
      "id": "7211e226-7802-41fd-8d55-2720fe9d534f",
      "firstName": "George",
      "lastName": "Bluth",
      "email": "george@bluth.example"
    },
    "hiringTeam": [],
    "appliedViaJobPostingId": null,
    "submitterClientIp": null,
    "submitterUserAgent": null
  }
}