Segmentation 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_RECEIVABLE
ACCOUNTSRECEIVABLE
ACTIVITIES
BILLS
CONTACT_INFORMATION
JOBS
PAYMENTS
PAYMENT_GATEWAY_CARDS
PAYMENT_GATEWAY_REQUESTS
AWARD_REWARD_TRANSACTIONS
SPEND_REWARD_TRANSACTIONS
REWARDS_PARTICIPANTS
SERVICE_REQUESTS
SUBSCRIPTIONS
BUY_IN_ADVANCE_REQUESTS
BUYINADVANCEREQUESTS
CONTACTINFORMATION
CREDITNOTES
INVOICES
INVOICECANCELLATIONS
JOBS
LEADS
PAYMENTGATEWAYCARDS
PAYMENTGATEWAYREQUESTS
PAYMENTS
PAYMENTCANCELLATIONS
REFUNDS
REWARDAWARDTRANSACTIONS
REWARDOFFERS
REWARDPARTICIPANTS
REWARDSPENDTRANSACTIONS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS
WRITEOFFS
SUBSCRIPTIONACTIONS
Tip
SUBSCRIPTIONACTIONS is available from CRM.COM R14.2.0
CREDITNOTES, INVOICES, INVOICECANCELLATIONS, LEADS, PAYMENTCANCELLATIONS, REFUNDS, REWARDOFFERS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_value
(mandatory and applicable only on add)
String
The primary key value of the entity which is added as an exceptional item of the retrieved segment