Update an enrolled promotion
patch
/crmRestApi/resources/11.13.18.05/loyMembers/{MemberNumber}/child/promotions/{LoyPromomemId}
Request
Path Parameters
-
LoyPromomemId(required): integer(int64)
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute.
-
MemberNumber(required): string
The member number. This attribute is an alternative identifier for a loyalty member and is displayed in the UI. There is no default value, dependency, or limitation associated with this attribute.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
EligFlg: string
Title:
Eligibility
Maximum Length:1
Default Value:N
Indicates if member is eligible or enrolled. -
EnrollmentEnd: string
(date-time)
Title:
Enrollment End Date
The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Enrollment Start Date
The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
IncentiveChoice: string
Title:
Incentive Choice
The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
OfferNum: string
Title:
Offer Number
Maximum Length:30
. -
PromotionName: string
Title:
Promotion Name
The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : loyMembers-promotions-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The details of who updated the member enrollment into an enrollable promotion. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute. -
CreationDate: string
(date-time)
Title:
Created Date
Read Only:true
The date when the member enrollment into an enrollable promotion is created. Oracle Loyalty Cloud generates this attribute value during the creation of a new promotion. There is no default value, dependency, or limitation associated with this attribute. -
EligFlg: string
Title:
Eligibility
Maximum Length:1
Default Value:N
Indicates if member is eligible or enrolled. -
EnrollmentEnd: string
(date-time)
Title:
Enrollment End Date
The promotion enrollment end date, which is the date until the current member is enrolled to a particular enrollable promotion. The promotion enrollment end date should be later than promotion enrollment start date. There is no default value associated with this attribute. -
EnrollmentStart: string
(date-time)
Title:
Enrollment Start Date
The date when the promotion enrollment begins. A loyalty member can be enrolled into a particular promotion beginning on this date. There is no default value, dependency, or limitation associated with this attribute. -
IncentiveChoice: string
Title:
Incentive Choice
The incentive choice option for an enrollable promotion. One of the many defined preferred choices can be setup for each member. If no choice is selected for a member, the one defined as a default incentive choice is used. There is no dependency or limitation associated with this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the member enrollment into an enrollable promotion was last updated. Oracle Loyalty Cloud generates this attribute value, and updates it whenever there are any changes to the promotion. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdatedBy: string
Title:
Changed By
Read Only:true
Maximum Length:64
The user that updates the member enrollment into an enrollable promotion record. Oracle Loyalty Cloud populates this value when the loyalty administrator updates the member enrollment into an enrollable Promotion in the Oracle Loyalty Cloud UI. There is no default value, dependency, or limitation associated with this attribute. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last logged in. Oracle Loyalty Cloud generates this attribute value, and updates it whenever any changes to the member enrollment into an enrollable promotion take place. There is no default value, dependency, or limitation associated with this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoyPromomemId: integer
(int64)
Title:
Loyalty Promotion Member ID
The loyalty promotion member identifier, which is the primary identifier to uniquely identify a loyalty member enrolled into a loyalty promotion for a given period. There is no default value, dependency, or limitation associated with this attribute. -
MemberId: integer
(int64)
Title:
Member ID
The primary key of the member identifier who is currently enrolled in an enrollable promotion. There is no default value or limitation associated with this attribute. -
MemberNumber: string
Title:
Member Number
Maximum Length:30
The loyalty member number, which is an alternative key to identify a member. This number is shown along with the promotion name when identifying a member enrollment into an enrollable promotion for a given start and end date. There is no default value, dependency, or limitation associated with this attribute. -
OfferNum: string
Title:
Offer Number
Maximum Length:30
. -
PromoMemNumber: string
Title:
Promotion Member Number
The public unique identifier of a member promotion enrolled object which is unique to a given enrollment for a given time period. There is no default value or limitation associated with this attribute. -
PromotionName: string
Title:
Promotion Name
The loyalty promotion name which has the enrollable promotion flag enabled and for which the enrollment start and end date is specified for the current loyalty member. There is no default value, dependency, or limitation associated with this attribute. -
PromotionNumber: string
Title:
Promotion Number
Read Only:true
Maximum Length:30
The promotion number that has been applied to the member during the transaction processing. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCode: string
Title:
Promotion Sub Type
Read Only:true
Maximum Length:30
The loyalty promotion subtype shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
SubTypeCodeMeaning: string
Title:
Promotion Sub Type Meaning
Read Only:true
Maximum Length:80
The sub type meaning of the promotion. This is dependent on the promotion type. There is no default value or limitation associated with this attribute. -
TypeCode: string
Title:
Promotion Type
Read Only:true
Maximum Length:30
The loyalty promotion type shows the enrolled promotion from the member enrollment for a given start and finish date. There is no default value, dependency, or limitation associated with this attribute. -
TypeCodeMeaning: string
Title:
Promotion Type Meaning
Read Only:true
Maximum Length:80
The type meaning of the promotion which is based on the promotion type code. There is no default value or limitation associated with this attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.