INPUT_OBJECT

CreateEmailInput

link GraphQL Schema definition

  • input CreateEmailInput {
  • clientMutationId: String
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Extra raw email headers preserved from the source message, as a JSON object.
  • additionalHeaders: JSONString
  • # HTML body of the email. Returned only to users with read permission on the email
  • # content; otherwise empty.
  • body: String
  • # Plain-text summary of the email body. Returned only to users with read
  • # permission on the email content; otherwise empty.
  • bodySummary: String
  • # Comma-separated list of carbon-copy recipients.
  • cc: String
  • # Id of the company email.
  • companyEmailId: ID
  • # How the email body is shared with non-owners (e.g. Private hides the body,
  • # Public makes it visible to anyone with read access on the email envelope).
  • contentShareMode: ContentShareModeEnum
  • # MIME content type of the body (e.g. text/html, text/plain).
  • contentType: String
  • # Timestamp the email was sent. Empty for drafts and scheduled emails not yet
  • # sent.
  • dateSent: DateTime
  • # Direction of the email (Incoming, Outgoing).
  • direction: EmailDirectionEnum!
  • # Numeric error code recorded when the email failed to send. Zero when no error
  • # occurred.
  • errorCode: Int
  • # True when delivery tracking is enabled. Tracked emails generate EmailEvent
  • # records on open/click.
  • isTracked: Boolean
  • # External identifier of the email on the source mailbox (e.g. IMAP Message-ID).
  • # Used to deduplicate when re-syncing.
  • originalId: String
  • # Id of the email owner.
  • ownerId: ID
  • # Id of the parent (master) email.
  • parentEmailId: ID
  • # Scheduling configuration for delayed sending (e.g. timezone, time-window).
  • scheduleSettings: JSONString
  • # Timestamp at which a scheduled email is queued to be sent. Empty for
  • # immediately-sent emails.
  • sendAt: DateTime
  • # Sender address as it appeared on the email (free-text "From" header).
  • sender: String
  • # Id of the matched sender account.
  • senderAccountId: ID
  • # Id of the matched sender user.
  • senderClientId: ID
  • # Id of the matched sender contact.
  • senderContactId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • sentiment: EmailSentimentEnum
  • # Sharing model for the email envelope (e.g. shared with selected sales units or
  • # selected users). The matching sharing_units / sharing_clients lists control who
  • # is granted access.
  • shareMode: ShareModeEnum
  • # Name of the entity and its default text representation.
  • subject: String
  • # Id of the email template.
  • templateId: ID
  • # Identifier grouping emails belonging to the same conversation thread.
  • threadId: ID
  • # Comma-separated list of primary recipients.
  • to: String
  • # Email category (e.g. regular email, mass email, calendar invitation).
  • type: EmailTypeEnum
  • # IMAP UID of the email on the source mailbox.
  • uid: String!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Sales units that have been granted shared access to this email envelope.
  • sharingUnits: [CreateMessageSharingSalesUnitRelationNoMessageBackrefInput!]
  • # Users that have been granted shared access to this email envelope.
  • sharingClients: [CreateMessageSharingClientRelationNoMessageBackrefInput!]
  • # Sales units that have been granted access to the email body when
  • # content_share_mode is restricted.
  • contentSharingUnits: [CreateEmailContentSharingSalesUnitRelationNoEmailBackrefInput!]
  • # Users that have been granted access to the email body when content_share_mode is
  • # restricted.
  • contentSharingClients: [CreateEmailContentSharingClientRelationNoEmailBackrefInput!]
  • # Accounts this email is linked to.
  • accountRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Contacts this email is linked to.
  • contactRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Projects this email is linked to.
  • projectRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Custom entity records this email is linked to.
  • customEntityRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Leads this email is linked to.
  • leadRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Opportunities this email is linked to.
  • opportunityRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Quotes this email is linked to.
  • quoteRelations: [CreateMessageRelationNoMessageBackrefInput!]
  • # Tag labels applied to this email. Visible only to users that can read the email
  • # body.
  • tags: [CreateTagRelationNoEmailBackrefInput!]
  • # Attachments and other documents linked to this email.
  • documents: [CreateCloudObjectRelationNoBackrefInput!]
  • }

link Require by