referral.delete

Deletes a referral submission by id. The referralId is the id returned by referral.list.

The optional clearAttribution field controls whether attribution is also removed from the associated application:

  • None is the default and deletes only the referral.
  • CreditedToUser clears the credited user. This is recommended when the employee should no longer see the candidate in their personal Referral dashboard because it preserves Referral as the source for org-level sourcing analytics.
  • Source clears the source.
  • All clears both the credited user and source.

Attribution is cleared only when it still belongs to the referral. The credited user must still be the referral's referrer. The source must still be the built-in source for the referral type, which is Referral for direct referrals and Referral Link for social referrals. The response flags report which requested fields were actually cleared.

The associated application is not deleted. Restoring the referral within the 7-day restoration window restores only the referral row and does not restore cleared attribution. Returns referral_not_found when the referral does not exist or is not visible to the acting user.

Requires the candidatesDelete permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid
required
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

The unique identifier for the referral to delete, from referral.list

string
enum
Defaults to None

Controls which application attribution fields are cleared when they still belong to this referral. Use CreditedToUser to remove the candidate from the employee's Referral dashboard while preserving Referral as the source.

Allowed:
Response

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json