Offer

Represents a specific, actionable proposition of value, often featuring an incentive or discount designed to prompt the target audience to take a desired immediate action, such as purchase or sign-up. This object is available in API version 66.0 and later.

Supported Calls

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

Fields

Field Details
CampaignId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the campaign associated with the offer.
This field is a relationship field.
Relationship Name
Campaign
Refers To
Campaign
CouponCodeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the coupon code associated with the offer.
This field is a relationship field.
Relationship Name
CouponCode
Refers To
Coupon
Description
Type
textarea
Properties
Create, Filter, Sort, Update
Description
The description of the offer
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The end date and time until which the offer is available for customers to use.
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
Create, Filter, Group, idLookup, Sort, Update
Description
The name of the offer.
OfferCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique code of the offer.
OfferConfiguration
Type
textarea
Properties
Create, Nillable, Update
Description
The JSON-based configuration of the offer.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this record.
This field is a polymorphic relationship field.
Relationship Name
Owner
Refers To
Group, User
PriorityNumber
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The priority of the current offer compared to the other offers of the related promotion.
PromotionId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the promotion associated with the offer.
This field is a relationship field.
Relationship Name
Promotion
Refers To
Promotion
RecordTypeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the record type associated with the offer.
This field is a relationship field.
Relationship Name
RecordType
Refers To
RecordType
StartDateTime
Type
dateTime
Properties
Create, Filter, Sort, Update
Description
The start date and time from which the offer is available for customers to use.
Status
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of the offer.
Possible values are:
  • Active
  • Draft
  • InProgress
  • Inactive
  • New
UsageType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Speciies the usage type of the offer.
Possible values are:
  • PromotionalOffer
The default value is PromotionalOffer.

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.

OfferFeed
Feed tracking is available for the object.
OfferHistory
History is available for tracked fields of the object.
OfferOwnerSharingRule
Sharing rules are available for the object.
OfferShare
Sharing is available for the object.