Merge · Schema

PatchedOpportunityRequest

# The Opportunity Object ### Description The `Opportunity` object is used to represent a deal opportunity in a CRM system. ### Usage Example TODO

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
name	stringnull	The opportunity's name.
description	stringnull	The opportunity's description.
amount	integernull	The opportunity's amount.
owner	stringnull	The opportunity's owner.
account	stringnull	The account of the opportunity.
stage	stringnull	The stage of the opportunity.
status	object	The opportunity's status.
last_activity_at	stringnull	When the opportunity's last activity occurred.
close_date	stringnull	When the opportunity was closed.
opportunity_url	stringnull	The opportunity's URL in the remote system.
integration_params	objectnull
linked_account_params	objectnull
remote_fields	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PatchedOpportunityRequest",
  "title": "PatchedOpportunityRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The opportunity's name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "The opportunity's description."
    },
    "amount": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The opportunity's amount."
    },
    "owner": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The opportunity's owner."
    },
    "account": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The account of the opportunity."
    },
    "stage": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid",
      "description": "The stage of the opportunity."
    },
    "status": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/OpportunityStatusEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The opportunity's status."
    },
    "last_activity_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the opportunity's last activity occurred."
    },
    "close_date": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the opportunity was closed."
    },
    "opportunity_url": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The opportunity's URL in the remote system."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "remote_fields": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/RemoteFieldRequest"
      }
    }
  },
  "description": "# The Opportunity Object\n### Description\nThe `Opportunity` object is used to represent a deal opportunity in a CRM system.\n### Usage Example\nTODO"
}