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
ClientEmail	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The email of the referred party
ClientName	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description The name of the referred party.
ClientPhone	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description The phone number of the referred party.
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
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.
OpportunityId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description Specifies the opportunity for the account or lead for which referral record is created. This field is a relationship field. Relationship Name Opportunity Refers To Opportunity
OrderId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The order associated with the Referral. This field is a relationship field. Relationship Name Opportunity Refers To Opportunity
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
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
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` `INTERNAL`—Reserved for internal use and isn't required for B2C or B2B referral programs. Don't use this value to customize or extend your implementation. `OUTBOUND`—Reserved for internal use and isn't required for B2C or B2B referral programs. Don't use this value to customize or extend your implementation.
ReferredPartyId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description The ID of the Contact or the Person Account of the friend referred by the advocatefor a B2C referral program. The ID of the Lead or the Business Account of the party referred by the advocate for a B2B referral program This field is a polymorphic relationship field. Relationship Name ReferredParty Relationship Type Lookup Refers To Account, Contact
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 for a B2C referral program. The ID of the Business Account of the advocate who submitted the referral for a B2B referral program This field is a polymorphic relationship field. Relationship Name Referrer Relationship Type Lookup Refers To Account, Contact, LoyaltyProgramMember
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 and isn't required for B2C or B2B referral programs. Don't use this field to customize or extend your implementation.
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`—Reserved for internal use and isn't required for B2C or B2B referral programs. Don't use this value to customize or extend your implementation. `Public Sector Solutions`—Reserved for internal use and isn't required for B2C or B2B referral programs. Don't use this value to customize or extend your implementation. `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.
ReferralOwnerSharingRule: Sharing rules are available for the object.
ReferralShare: Sharing is available for the object.

Referral Marketing Developer Guide

Referral

Supported Calls

Fields

Associated Objects