OppStatus

OppStatus

The status of an opportunity, such as whether it is accepting applications.

Table

Property	Type	Required	Description
value	OppStatusOptions	Yes	The status value
customValue	string	No	The display value for a custom status
description	string	No	A human-readable description of the status

Formats

Example

A JSON example of this field is:

// A standard status
{
  "value": "open",
  "description": "Opportunity is actively accepting applications"
}

// A custom status
{
  "value": "custom",
  "customValue": "review",
  "description": "Opportunity is in review by the program team"
}

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: OppStatus.yaml
type: object
properties:
  value:
    $ref: OppStatusOptions.yaml
    description: The status value
  customValue:
    type: string
    description: The display value for a custom status
  description:
    type: string
    description: A human-readable description of the status
required:
  - value
description: The status of an opportunity, such as whether it is accepting applications

TypeSpec

The TypeSpec code for this field is:

/** The status of the opportunity */
model OppStatus {
  /** The status value */
  value: OppStatusOptions;

  /** A human-readable description of the status */
  description?: string;
}

OppStatusOptions

The set of values accepted for opportunity status.

Table

Value	Description
forecasted	Opportunity is anticipated, but not yet accepting applications
open	Opportunity is actively accepting applications
closed	Opportunity is no longer accepting applications
custom	Custom opportunity status defined within the record

Formats

Example

A JSON example of this field is:

"open"

JSON Schema

The JSON schema for this field is:

$schema: https://json-schema.org/draft/2020-12/schema
$id: OppStatusOptions.yaml
type: string
enum:
  - forecasted
  - open
  - closed
  - custom
description: The set of values accepted for opportunity status

TypeSpec

The TypeSpec code for this field is:

/** The set of values accepted for opportunity status */
enum OppStatusOptions {
  forecasted,
  open,
  closed,
  custom,
}