Referral

Represents the details of a referral submitted by an advocate. This object is available in API version 59.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
CaseId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of a case that’s created by a referral. This field is a relationship field. Relationship Name Case Relationship Type Lookup Refers To Case
Category	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ClientEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ClientId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use. This field is a relationship field. Relationship Name Client Relationship Type Lookup Refers To Account
ClientLanguage	Type multipicklist Properties Create, Filter, Nillable, Update Description Reserved for internal use.
ClientName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ClientPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
Comments	Type textarea Properties Create, Nillable, Update Description The comments about the referral.
CurrentPromotionStageId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the promotion stage that the referral is at. This field is a relationship field. Relationship Name CurrentPromotionStage Relationship Type Lookup Refers To PromotionStage
Description	Type textarea Properties Create, Nillable, Update Description The description of the referral.
IsSelfReferred	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Reserved for internal use. The default value is `false`.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user referenced this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The most recent date on which a user viewed this record.
Name	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Required. The unique number of the record.
OutboundSourceId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use. This field is a polymorphic relationship field. Relationship Name OutboundSource Relationship Type Lookup Refers To Case, Referral
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The owner of the record. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
Priority	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
PromotionId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the referral promotion that the advocate signed up to submit the referral. This field is a relationship field. Relationship Name Promotion Relationship Type Lookup Refers To Promotion
ProviderEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The owner of the record.
ProviderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use. This field is a polymorphic relationship field. Relationship Name Provider Relationship Type Lookup Refers To Account, Contact
ProviderName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ProviderOrg	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ProviderPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ReferralDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The date on which the advocate submitted the referral.
ReferralType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort, Update Description Required. The type of referral. In Referral Marketing, the type is always Inbound. Possible values are: `INBOUND` `OUTBOUND`
ReferredPartyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID Contact or the Person Account of the friend referred by the advocate. This field is a polymorphic relationship field. Relationship Name ReferredParty Relationship Type Lookup Refers To Account, Contact
ReferrerEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ReferrerId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Contact or the Person Account of the advocate who submitted the referral. This field is a polymorphic relationship field. Relationship Name Referrer Relationship Type Lookup Refers To Account, Contact, LoyaltyProgramMember
ReferrerName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ReferrerOrg	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
ReferrerPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
Result	Type textarea Properties Create, Filter, Nillable, Sort, Update Description Reserved for internal use.
ResultCategory	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
Source	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description The source where the advocate submitted the referral. Possible values are: `Application` `Email` `Message` `Other` `Phone` `Social Media` `Walk-In`
Status	Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
Title	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Reserved for internal use.
UsageType	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies which Salesforce product that created the record. Possible values are: `Loyalty Management` `Public Sector Solutions` `Referral Management`—Use this value for Referral Marketing activities.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

ReferralFeed: Feed tracking is available for the object.
ReferralHistory: History is available for tracked fields of the object.
ReferralShare: Sharing is available for the object.

Referral Marketing Developer Guide

Referral

Supported Calls

Fields

Associated Objects