Table of contents

    Overview

    OpportunityOutomeReason represents the checkboxes in ‘Reason’ area in edit opportunity page on the front end UI when the outcome drop-down is ‘Result’. Clients can create, edit or archive OpportunityOutomeReason in ARM customisations. To call the OpportunityType endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/OpportunityOutcomeReason
    https://api.mypcorp.com/OpportunityOutcomeReason/{OutcomeReasonId}

    Get

    The following table illustrates which fields can be included when receiving a GET response.

    NB: Nested properties are hidden by default. To expand all nested properties, add a query parameter $expand=* to the URL.

    OpportunityOutcomeReason
    Field Description
    OutcomeReasonId
    integer (Identifier)
    Opportunity outcome reason id.
    Name
    string
    The name of the opportunity outcome reason.
    Outcome
    string
    The opportunity outcome.
    Possible values are:
    “Deferred”
    “SaleSuccessful”
    “SaleUnsuccessful”
    ArchiveDate
    datetime
    Date when the opportunity outcome reason was archived, if it has been archived.

    Example JSON response format:

    {
      "@odata.context": "https://api.mypcorp.com/$metadata#OpportunityOutcomeReason",
      "value": [
        {
          "OutcomeReasonId": 100,
          "Name": "Approval being sought",
          "Outcome": "Deferred",
          "ArchiveDate": null
        }
      ]
    }

    Previous article Next article