INPUT_OBJECT

UpdateOpportunityInput

link GraphQL Schema definition

  • input UpdateOpportunityInput {
  • # Optional client-supplied identifier passed on a mutation input and echoed back
  • # unchanged on its payload, so a client can correlate the response with its
  • # request (Relay convention).
  • clientMutationId: String
  • # Unique identifier of entity.
  • id: ID!
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Id of the active quote.
  • activeQuoteId: ID
  • # Expected or actual closing date of the opportunity.
  • closingDate: Date
  • # Id of the currency exchange rate list applied to this opportunity.
  • currencyExchangeRatesListId: ID
  • # Free-form description of the opportunity.
  • description: String
  • # True when the opportunity has been archived (lost). Archived opportunities
  • # remain readable but are hidden from active lists and cannot be edited until
  • # reactivated.
  • isArchived: Boolean
  • # True when value is auto-calculated from the opportunity product line items.
  • # False when the user enters value directly.
  • isValueAutoCalculate: Boolean
  • # User-set colored flag used to highlight the opportunity in lists and reports.
  • labelFlag: Int
  • # Time when an AI-suggested buying center was last applied to this opportunity.
  • lastAiBuyingCenterApplied: DateTime
  • # Id of the lead source.
  • leadSourceId: ID
  • # Name of the entity and its default text representation.
  • name: String
  • # Id of the opportunity type.
  • opptyTypeId: ID
  • # Id of the opportunity owner.
  • ownerId: ID
  • # Id of the product currency.
  • productCurrencyId: ID
  • # Id of the product price list.
  • productPriceListId: ID
  • # Product sections grouping the record's line items, as a JSON array of {"id":
  • # , "name": } objects. Validated on write. Full structure:
  • # https://graphql.api-doc.pipelinersales.com/latest/graphql/space/productsection.doc.html
  • productSections: JSONString
  • # Free-text company email captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountEmail: String
  • # Free-text company name captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountName: String
  • # Free-text company phone captured at opportunity creation when no Account record
  • # has been linked yet.
  • quickAccountPhone: String
  • # Free-text contact name captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickContactName: String
  • # Free-text contact email captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickEmail: String
  • # Free-text contact phone captured at opportunity creation when no Contact record
  • # has been linked yet.
  • quickPhone: String
  • # Qualitative ranking score (1-10) the user assigns to indicate the strength of
  • # the opportunity.
  • ranking: Int
  • # Free-form note explaining why the opportunity was archived (lost).
  • reasonOfCloseDescription: String
  • # Id of the reason-of-close value.
  • reasonOfCloseId: ID
  • # Sharing model applied on top of the owner/unit visibility (e.g. shared with
  • # selected sales units or selected users). The matching sharing_units /
  • # sharing_clients lists control who is granted access.
  • shareMode: ShareModeEnum
  • # Id of the pipeline step.
  • stepId: ID
  • # Id of the sales unit.
  • unitId: ID
  • # True when the opportunity has gone through the qualification step at least once.
  • wasQualified: Boolean
  • customFields: JSONString
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Monetary value of the opportunity in the team space base currency, with the
  • # foreign value and currency code preserved alongside.
  • value: CurrencyForeignFieldInput
  • # Recurrence schedule generating periodic copies of this opportunity, or empty
  • # when no recurrence is set up.
  • opptyRecurrence: UpdateOpptyRecurrenceNoOpptyBackrefInput
  • # Revenue schedule splitting the opportunity value across periods, or empty when
  • # revenue scheduling is not enabled for this opportunity.
  • revenueSchedule: UpdateOpptyRevenueScheduleNoIdBackrefInput
  • # Product line items on this opportunity. Each entry holds the product, quantity,
  • # price and discount that contribute to the opportunity value when
  • # is_value_auto_calculate is true.
  • productRelations: [CreateOrUpdateOpptyProductRelationNoBackrefInput!]
  • # Contacts linked to this opportunity, including their roles and org-chart
  • # positions.
  • contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!]
  • # Accounts linked to this opportunity, including the primary-account flag.
  • accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!]
  • # Documents linked to this opportunity.
  • documents: [CreateCloudObjectRelationNoBackrefInput!]
  • # Quotes prepared for this opportunity.
  • quoteRelations: [CreateQuoteNoOpptyBackrefInput!]
  • # Timestamp of when the opportunity was won. Setting it adjusts the underlying win
  • # event; empty for opportunities that have not been won.
  • wonDate: DateTime
  • # Timestamp of when the opportunity was archived (lost). Setting it adjusts the
  • # underlying loss event; empty for opportunities that have not been archived.
  • lostDate: DateTime
  • # Sales units that have been granted shared access to this opportunity. Editable
  • # only when share_mode allows unit sharing.
  • sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]
  • # Users that have been granted shared access to this opportunity. Editable only
  • # when share_mode allows user sharing.
  • sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]
  • # Tag labels applied to this opportunity.
  • tags: [CreateTagRelationNoOpptyBackrefInput!]
  • # Saved view profiles this opportunity currently matches.
  • staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!]
  • }

link Require by