Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlesubscription action object response data

Name

Type

Description

id

String

The ID of the retrieved subscription action

number

String

The number of the retrieved subscription action

transaction_reference_numberString

The unique transaction reference number of the retrieved subscription action

Tip

Available from CRM.COM R13.1.0

life_cycle_state

String

The life cycle state of the subscription action. One of the following values is returned:

EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED

behavior_codeString

The behavior code of the subscription action

business_classification_codeString

The business classification code of the subscription action

scheduled_dateDate

The date that the subscription was scheduled to be executed

executed_onDateThe date that the subscription action is executed
submitted_onDateThe date that the business action was submitted into the system
performed_onDateThe date that the business action was actually performed, which might be different than the date that was submitted into the system
submitted_by User objectObjectThe user that  submitted the action into the system
performed_by User objectObjectThe user that actually performed the subscription action, which might be different than the user that submitted the action into the system
performed_by_unit Unit Object

The unit that performed the subscription action

Tip

Available from CRM.COM R14.0.0

action_typeSubscription action type objectAction Type ObjectThe action type of the subscription action
sub_action_typeSubscription sub action type objectSub Action Type ObjectThe sub action type of the subscription action
subscriptionSubscription objectObjectThe subscription that was modified by the execution of the subscription action
jobJob Object

The Job for which the subscription action was performed

Tip

Available from CRM.COM R9.0.0

Anchor
subscription_action referred objects
subscription_action referred objects
Referred Objects Response Data

Include Page
user_short
user_short

Include Page
unit_short
unit_short

Include Page
subscription_action_type_short
subscription_action_type_short

Include Page
subscription_sub_action_type_short
subscription_sub_action_type_short

Include Page
subscription_short
subscription_short

Include Page
job_short
job_short