Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Name

Type

Description

id

String

The ID of the retrieved alertapproval request

number

String

The number of the retrieved alert approval request

unified_codeStringThe unified code of the retrieved approval request
life_cycle_stateString

The life cycle state of the retrieved alert approval request which can be SUCCESSFUL or REJECTED

typeStringThe type of the retrieved alert which can be EMAIL or SMS

PENDING, APPROVED, REJECTED or CANCELLED

entityString

The name of the entity that was communicated through the alertrelated with the approval request. The supported entities are the following:

  • ACTIVITIES
  • ADHOCDISCOUNT
  • CREDITNOTES

  • INVOICES

  • JOBS

  • LEADS
  • PAYMENTS
  • REFUNDS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
Tip
  • REWARDOFFERS entity is available from CRM.COM R11.0.0
  • LEADS entity is available from CRM.COM R14.0.0
  • ADHOCDISCOUNT, CREDITNOTES, INVOICES, PAYMENTS, REFUNDS are available from CRM.COM R15.0.0
entity_idStringThe ID of the entity that was communicated through the alert related to the approval request
subjectString

The subject of the retrieved alert. This is applicable only if the type is EMAIL

content

approval request

responseStringThe content response of the retrieved alertapproval request
recipientresponse_email_addressdateStringThe email address of the recipient. This is applicable only if the type is EMAIL
recipient_phone_numberNumberThe phone number of the recipient. This is applicable only if the type is SMS
error_codeStringThe code of the error that occurred while sending the alert. This is applicable only for rejected alerts
error_descriptionStringThe description of the error that occurred while sending the alert. This is applicable only for rejected alerts
recipientUser ObjectThe recipient user of the retrieved alert
alert_definitionAlert Definition ObjectThe alert DateThe date that a response was provided for the retrieved approval request
responded_byUser ObjectThe user that responded to the retrieved approval request
approval_definitionApproval Definition ObjectThe approval definition that was used to send create the alertapproval request
workflow_ruleWorkflow Rule ObjectThe workflow rule that triggered the alertapproval request
authorised_users_setSet of Users ObjectsThe users that are authorised to approve, reject or cancel the approval request
log_informationLog Information ObjectThe log information of the retrieved alert approval request

Anchor
alert approval request referred objectsalert
approval request referred objects
Referred Objects Response Data

Include Page
user_short
user_short

Include Page
alertapproval_definition_shortalert
approval_definition_short

Include Page
workflow_rule_short
workflow_rule_short

...