Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleSegmentation exceptional items parameters object data
action

(mandatory)

String

Defines if a new or existing information will be updated.The supported values are the following:

ADD, REMOVE

id

(mandatory and applicable only on remove)

String

The ID of the segmentation exceptional item to be updated

 

entity_name

(mandatory and applicable only on add)

 String

 

The entity name of the retrieved segment which can be one of the following:

  • ACCOUNTS_RECEIVABLEACCOUNTSRECEIVABLE
  • ACTIVITIES
  • BILLS
  • CONTACT_INFORMATIONCONTACTINFORMATION
  • JOBS
  • PAYMENTS
  • PAYMENT_GATEWAY_CARDS
  • PAYMENT_GATEWAY_REQUESTS
  • AWARD_REWARD_TRANSACTIONS
  • SPEND_REWARD_TRANSACTIONS
  • REWARDS_PARTICIPANTS
  • SERVICE_REQUESTS
  • SUBSCRIPTIONS
  • BUY_IN_ADVANCE_REQUESTSPAYMENTGATEWAYCARDS
  • PAYMENTGATEWAYREQUESTS
  • REWARDAWARDTRANSACTIONS
  • REWARDSPENDTRANSACTIONS
  • REWARDSPARTICIPANTS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • BUYINADVANCEREQUESTS

entity_value

(mandatory and applicable only on add)

StringThe primary key value of the entity which is added as an exceptional item of the retrieved segment