Table of contents

    Overview

    OpportunityStage indicates the stage that the Opportunity is at. Clients can create, edit or archive opportunity stages in ARM customisations. To call the OpportunityStage endpoint, use one of the URLs from the following table:

    URL GET PUT POST DELETE
    https://api.mypcorp.com/opportunityStage
    https://api.mypcorp.com/opportunityStage/{StageId}

    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.

    OpportunityStage
    Field Description
    StageId
    integer (Identifier)
    Opportunity stage id.
    Name
    string
    The name of the opportunity stage.
    ArchiveDate
    datetime
    Date when the opportunity stage was archived, if it has been archived.

    Example JSON response format:

    {
      "@odata.context": "api.mypcorp.com/$metadata#OpportunityStage",
      "value": [
        {
          "StageId": 15,
          "Name": "Result",
          "ArchiveDate": null
        }
      ]
    }

    Previous article Next article