Pipeline

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Pipeline",
  "title": "Pipeline",
  "type": "object",
  "x-apideck-schema-id": "Pipeline",
  "x-apideck-weights": {
    "id": "critical",
    "name": "critical",
    "currency": "low",
    "archived": "low",
    "display_order": "edge-case",
    "win_probability_enabled": "edge-case",
    "stages": "high",
    "updated_at": "medium",
    "created_at": "medium"
  },
  "required": [
    "name"
  ],
  "x-pii": [],
  "properties": {
    "id": {
      "description": "The unique identifier of the Pipeline.",
      "type": "string",
      "example": "default"
    },
    "name": {
      "description": "The name of the Pipeline.",
      "type": "string",
      "example": "Sales Pipeline",
      "minLength": 1
    },
    "currency": {
      "$ref": "#/components/schemas/Currency"
    },
    "archived": {
      "description": "Whether the Pipeline is archived or not.",
      "type": "boolean",
      "example": false
    },
    "active": {
      "description": "Whether the Pipeline is active or not.",
      "type": "boolean",
      "example": false
    },
    "display_order": {
      "description": "The order in which the Pipeline is displayed in the UI.",
      "type": "integer",
      "example": 1,
      "nullable": true
    },
    "win_probability_enabled": {
      "description": "Whether the Pipeline has win probability enabled or not.",
      "type": "boolean",
      "example": true
    },
    "stages": {
      "description": "The Pipeline Stages.",
      "type": "array",
      "items": {
        "x-apideck-weights": {
          "id": "medium",
          "name": "medium",
          "value": "medium",
          "win_probability": "medium",
          "display_order": "medium",
          "archived": "low",
          "created_at": "low",
          "updated_at": "low"
        },
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "The unique identifier of the Pipeline Stage.",
            "type": "string",
            "example": "contractsent",
            "readOnly": true,
            "nullable": true
          },
          "name": {
            "description": "The name of the Pipeline Stage.",
            "type": "string",
            "example": "Contract Sent",
            "nullable": true
          },
          "value": {
            "description": "The value of the Pipeline Stage.",
            "type": "string",
            "example": "CONTRACT_SENT",
            "nullable": true
          },
          "win_probability": {
            "type": "integer",
            "example": 50,
            "description": "The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].",
            "nullable": true
          },
          "display_order": {
            "description": "The order in which the Pipeline Stage is displayed in the UI.",
            "type": "integer",
            "example": 1,
            "nullable": true
          },
          "archived": {
            "description": "Whether the Pipeline Stage is archived or not.",
            "type": "boolean",
            "example": false,
            "nullable": true
          },
          "created_at": {
            "description": "The date and time when the Pipeline Stage was created.",
            "type": "string",
            "format": "date-time",
            "example": "2020-09-30T07:43:32.000Z",
            "readOnly": true,
            "nullable": true
          },
          "updated_at": {
            "description": "The date and time when the Pipeline Stage was last updated.",
            "type": "string",
            "format": "date-time",
            "example": "2020-09-30T07:43:32.000Z",
            "readOnly": true,
            "nullable": true
          }
        }
      }
    },
    "updated_at": {
      "type": "string",
      "title": "Updated at (timestamp)",
      "description": "The date and time when the object was last updated.",
      "format": "date-time",
      "example": "2020-09-30T07:43:32.000Z",
      "readOnly": true,
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "title": "Created at (timestamp)",
      "description": "The date and time when the object was created.",
      "format": "date-time",
      "example": "2020-09-30T07:43:32.000Z",
      "readOnly": true,
      "nullable": true
    },
    "pass_through": {
      "$ref": "#/components/schemas/PassThroughBody"
    }
  },
  "additionalProperties": false
}