PromotionStage

Represents a stage when the promotion sends an email to the promotion’s target audience. With Global Promotions Management, a promotion launch email is sent after the promotion is activated. This object is available in API version 60.0 and later.

Supported Calls 

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

Fields 

ApiName 

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Required. The unique name of the promotion stage.

Configuration 

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: The configuration of the promotion stage.

Description 

  • Type: textarea
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The description of the promotion stage.

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 promotion stage.

PromotionId 

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description: The ID of the promotion that the stage belongs to.

    This field is a relationship field.

  • Relationship Name: Promotion

  • Relationship Type: Lookup

  • Refers To: Promotion

SequenceNumber 

  • Type: int
  • Properties: Create, Filter, Group, Sort, Update
  • Description: Required. The sequence number of the stage in a promotion. The sequence number of the Promotion Launched stage is 1.

Type 

  • Type: picklist

  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update

  • Description: Required. The type of promotion stage.

  • Possible values:

    • Promotion Launched

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.

PromotionStageEvent

Change events are available for the object.