OBJECT

CompanyEmailEntity

Shared company mailbox connected to the space that users can send emails from, such as a sales or support address.

link GraphQL Schema definition

  • type CompanyEmailEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Email address of the company mailbox (the From address).
  • email: String
  • # False when the mailbox is disabled (either by the user or because the underlying
  • # feature is not available); true otherwise.
  • enabled: Boolean!
  • # Error code recorded for the mailbox; empty when healthy. Set on integration
  • # failures or when the user disables the integration.
  • errorCode: Int
  • # Display name of the company email account, shown in the UI.
  • name: String!
  • # URL of the avatar image used as the sender picture for emails sent from this
  • # account.
  • pictureUrl: String
  • # Email service the company email account is connected through and sends from:
  • # Microsoft 365, Google or SendGrid.
  • serviceType: EmailServiceTypeEnum!
  • # Provider-specific configuration for the mailbox (e.g. parse_subdomain for
  • # SendGrid).
  • settings: JSONString
  • # OAuth/secret credentials for the mailbox. Read-only and only returned to
  • # service-to-service callers; setting via the public API is not supported.
  • token: String
  • # List of capabilities supported by the underlying email service (e.g.
  • # CanSyncBounces, CanSyncIncoming).
  • features: [EmailAccountFeatureEnum!]!
  • # Stable UUID derived from the mailbox address and service type, used to correlate
  • # the company email account with its integration settings entry.
  • mailboxId: UUID
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Daily sending limit of the email account and the number of emails sent from it
  • # in the last 24 hours.
  • limits: EmailAccountLimit!
  • }

link Require by