INPUT_OBJECT

CreateOrUpdateLeadInput

link GraphQL Schema definition

  • input CreateOrUpdateLeadInput {
  • clientMutationId: String
  • # Unique identifier of entity.
  • id: ID
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Id of the currency exchange rate list applied to this lead.
  • currencyExchangeRatesListId: ID
  • # Free-form description of the lead.
  • description: String
  • # True when the lead has been archived (lost). Archived leads remain readable but
  • # are hidden from active lists and cannot be edited until reactivated.
  • isArchived: Boolean
  • # User-set colored flag used to highlight the lead in lists and reports.
  • labelFlag: Int
  • # Id of the lead source.
  • leadSourceId: ID
  • # Id of the lead type.
  • leadTypeId: ID
  • # Name of the entity and its default text representation.
  • name: String
  • # Id of the lead owner.
  • ownerId: ID
  • # Free-text company email captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountEmail: String
  • # Free-text company name captured at lead creation when no Account record has been
  • # linked yet.
  • quickAccountName: String
  • # Free-text company phone captured at lead creation when no Account record has
  • # been linked yet.
  • quickAccountPhone: String
  • # Free-text contact name captured at lead creation when no Contact record has been
  • # linked yet.
  • quickContactName: String
  • # Free-text contact email captured at lead creation when no Contact record has
  • # been linked yet.
  • quickEmail: String
  • # Free-text contact phone captured at lead 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 lead.
  • ranking: Int
  • # Free-form note explaining why the lead was archived (lost). Captured alongside
  • # reason_of_close.
  • 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 lead process step.
  • stepId: ID
  • # Id of the sales unit.
  • unitId: ID
  • customFields: JSONString
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Contacts linked to this lead, including their roles and org-chart positions.
  • contactRelations: [CreateLeadOpptyContactRelationNoLeadOpptyBackrefInput!]
  • # Accounts linked to this lead, including the primary-account flag.
  • accountRelations: [CreateLeadOpptyAccountRelationNoLeadOpptyBackrefInput!]
  • # Sales units that have been granted shared access to this lead. Editable only
  • # when share_mode allows unit sharing.
  • sharingUnits: [CreateLeadOpptySharingSalesUnitRelationNoLeadOpptyBackrefInput!]
  • # Users that have been granted shared access to this lead. Editable only when
  • # share_mode allows user sharing.
  • sharingClients: [CreateLeadOpptySharingClientRelationNoLeadOpptyBackrefInput!]
  • # Documents linked to this lead.
  • documents: [CreateCloudObjectRelationNoBackrefInput!]
  • # Tag labels applied to this lead.
  • tags: [CreateTagRelationNoLeadBackrefInput!]
  • # Saved view profiles this lead currently matches.
  • staticProfiles: [CreateProfileRelationNoLeadOpptyBackrefInput!]
  • lostDate: DateTime
  • }