OutreachSourceCode

Represents information about a source code that's associated with an outreach campaign. 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()

Special Access Rules

This object is available only if the Fundraising Access license is enabled and the Fundraising User system permission is assigned to users

Fields

AudienceCount

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The number of person accounts, contacts, and businesses in this audience.

AudienceInformation

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Detailed information about the audience for the outreach source code. This field is available from API version 62.0 and later.

CampaignId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The parent campaign associated with this source code.

    This field is a relationship field.

  • Relationship Name: Campaign
  • Relationship Type: Lookup
  • Refers To: Campaign

CurrencyIsoCode

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Identifies the currency used for the gift transaction.
    Valid value is:
    • USD—U.S. Dollar

    Available in API version 61.0 and later.

  • Default value: USD

Description

  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The description of the source code.

FocusSegmentId

  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Lists individuals who are segmented for this source code.

    This field is available with a Data Cloud license.

    This field is a relationship field.

  • Relationship Name: MarketSegment
  • Relationship Type: Lookup
  • Refers To: MarketSegment

LastReferencedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last accessed this record indirectly, for example, through a list view or related record.

LastViewedDate

  • Type: dateTime
  • Properties: Filter, Nillable, Sort
  • Description: The timestamp when the current user last viewed this record or list view. If this value is null, and LastReferenceDate isn’t null, the user accessed this record or list view.

MessageChannel

  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The channel used for the message from which the donation originated. This field is available from API version 60.0 and later.
  • Possible values:
    • Digital Paid
    • Direct Mail
    • Email
    • Organic Web
    • Physical
    • SMS
    • Share Partner
    • Social Organic
    • Social Paid
    • Telemarketing

MessageChannelPlatform

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The outreach message channel platform from which the donation originated. This field is available from API version 60.0 and later.

MessageChannelPlatformAccount

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The platform account used to send the outreach message. This field is available from API version 60.0 and later.

MessageContent

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The outreach message content. This field is available from API version 60.0 and later.

MessageContentTitle

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The outreach message title. This field is available from API version 60.0 and later.

Name

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of the source code.

OwnerId

  • Type: reference
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: ID of the owner of this object. ID of the creator of this object.

    This field is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

SentDate

  • Type: dateTime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date and time that the outreach was sent. Available in API version 61.0 and later.

SourceCode

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The unique source code. This field is unique within your organization.

SourceCodeBaseUrl

  • Type: url
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The base URL for the outreach source code. This field is available from API version 60.0 and later.

SourceCodeUrl

  • Type: url
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The URL with UTM codes that's generated for the outreach source code. This field is available from API version 60.0 and later.

Status

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Description: The status of the source code.
  • Default value: Active
  • Possible values:
    • Active
    • Archived
    • Inactive

UsageType

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Specifies the usage of the outreach source code.
  • Default value: Fundraising
  • Possible values:
    • Fundraising

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.

OutreachSourceCodeChangeEvent (API Version 62.0)
Change events are available for the object.
OutreachSourceCodeFeed
Feed tracking is available for the object.
OutreachSourceCodeHistory
History is available for tracked fields of the object.
OutreachSourceCodeOwnerSharingRule
Sharing rules are available for the object.
OutreachSourceCodeShare
Sharing is available for the object.