Modify a Group

These calls make a request to modify information in an existing group. Only those fields with values supplied are modified in the Group object. If an extended object Attr field is supplied, it must be of the same type used to create the group.

If the catalog item defines a cycle which allows for purchase-time specification, you can set the OfferCycleType field to determine the purchased item cycle offset, and the cycle time of day if aligned to an existing cycle. Values are:
  • 1 - billing_cycle
  • 2 - purchase_time
  • 3 - balance_cycle
  • 4 - offer_cycle
  • 5 - fixed_offset
MATRIXX Engine generates an MtxGroupModifyEvent EDR when one or more of the following fields are modified:
  • ExternalId
  • Name
  • Tier
  • Attr
  • TimeZone
  • NotificationPreference
  • GlCenter
  • ServiceAddress
  • TaxStatus
  • TaxCertificate
  • TaxLocation

For more information about EDRs, see MATRIXX Integration.

Scheduling Life Cycle Transitions

Use the following modify APIs to schedule when the object status should transition:
  • MtxRequestSubscriberModify
  • MtxRequestGroupModify
  • MtxRequestDeviceModify
  • MtxRequestSubscriptionModify

Set the API field ScheduledStatusTransitionTime to specify an absolute future date and time when the status transition should take place. If you set a status (to transition to) and a ScheduledStatusTransitionTime, the status transition is scheduled. If you do not specify a ScheduledStatusTransitionTime, the status transition occurs immediately. If the new status to transition to is the same as the current status, an error is returned. To cancel an outstanding status transition request, set the IsCancelScheduledRequest field to "true".

The following object query APIs return the subscriber, group, and device object ScheduledStatusTransitionTime and IsCancelScheduledRequest field values, and the MtxPurchasedOffer objects (scheduled requests to suspend or resume).
  • MtxRequestSubscriberQuery
  • MtxRequestGroupQuery
  • MtxRequestDeviceQuery

REST Example

For information about the Attr field, see Data Objects.

Note: To modify an administrator, use the GroupAddMembership and GroupRemoveMembership APIs.
URL 
PUT http://host:port/rsgateway/data/v3/group/1-5-4-5
Request XML 
<MtxRequestGroupModify>
    <Name>New_Name</Name>
    <Tier>New_Tier</Tier>
</MtxRequestGroupModify>
Response 
<MtxResponse>
  <Result>0</Result>
  <ResultText>OK</ResultText>
</MtxResponse>