Skip to main content

Enums

AccountState​

The possible account states.

enum AccountState {
  PRECREATED
  TRIAL
  OPEN
  EXPIRED
  CLOSED
}

AdminEmailNotification​

The possible types of admin email notifications.

enum AdminEmailNotification {
  ADD_MORE_CREDITS_REQUEST_FOR_AI_DRAFTS
  UPGRADE_ACCOUNT_REQUEST_FOR_AI_OVERVIEW
}

AgentNotificationPreferenceNotificationNamespaceType​

Possible notification preference namespace

enum AgentNotificationPreferenceNotificationNamespaceType {
  notifications
}

AgentNotificationPreferenceNotificationType​

Possible notification types

enum AgentNotificationPreferenceNotificationType {
  EMAIL
  WEB
  DESKTOP
}

AgentOrderField​

The possible fields by which agents can be ordered.

enum AgentOrderField {
  CREATED_AT
  NAME
  UPDATED_AT
  ASSIGNMENT_COUNT
}

AgentRole​

The possible agent roles.

enum AgentRole {
  OWNER
  ADMIN
  AGENT
  VIEWER
}

AgentState​

The possible states of an agent.

enum AgentState {
  INVITED
  ACTIVE
  ARCHIVED
}

AgentTwoFactorAuthStatus​

The possible status of an agent's 2fa.

enum AgentTwoFactorAuthStatus {
  LOCKED
  CONFIRMED
  ENABLED
  DISABLED
}

AiConversationSuggestionType​

The possible types of conversation's AI suggestion.

enum AiConversationSuggestionType {
  TAGS
  SENTIMENT
  SUMMARY
}

ArticleOrderField​

The possible fields by which Knowledge Base articles can be ordered.

enum ArticleOrderField {
  AVERAGE_RATINGS
  TITLE
  UPDATED_AT
}

ArticleRatingTypes​

The possible types of Knowledge Base article ratings.

enum ArticleRatingTypes {
  EMOJI
  UPVOTE
}

AttachmentScanReportStatus​

The possible types of scan report status.

enum AttachmentScanReportStatus {
  OK
  FOUND
  WARNING
  PENDING
  FAILED
}

AttachmentType​

The possible types of Attachments.

enum AttachmentType {
  ATTACHMENT
  API_ATTACHMENT
  MAILED_ATTACHMENT
  MALICIOUS_ATTACHMENT
  SUSPICIOUS_ATTACHMENT
  UPLOADED_ATTACHMENT
}

AttachmentsConversationTypeEnum​

No description

enum AttachmentsConversationTypeEnum {
  ALL
  CURRENT
}

AuthState​

No description

enum AuthState {
  CHALLENGE
  SUCCESS
}

BodyPartTypeEnum​

No description

enum BodyPartTypeEnum {
  TEXT
  QUOTED
  NOTE
}

CannedReplyOrderField​

The possible fields by which canned replies can be ordered.

enum CannedReplyOrderField {
  CREATED_AT
  NAME
  CATEGORY
  UPDATED_AT
}

CategoryOrderField​

The possible fields by which canned reply categories can be ordered.

enum CategoryOrderField {
  CREATED_AT
  NAME
  UPDATED_AT
}

ChannelOrderField​

The possible fields by which channels can be ordered.

enum ChannelOrderField {
  CREATED_AT
  NAME
  POSITION
  UPDATED_AT
}

ChannelRestrictionType​

The possible channel restriction types, for resources linked to channels.

enum ChannelRestrictionType {
  ALL
  SPECIFIC
}

ChannelScope​

The permission scope applied to the list of channels

enum ChannelScope {
  CURRENT_USER
  ALL
}

ChannelState​

The possible states of a channel.

enum ChannelState {
  UNCONFIRMED
  DEMO
  CONFIRMED
  SYNCING
  ACTIVE
  ERROR
  DISCONNECTED
  MIGRATING
}

ChannelType​

The possible types of channels, representing various communication platforms.

enum ChannelType {
  FORWARDING
  GOOGLE
  FACEBOOK
  TWITTER
  OFFICE365
  IMAP
}

CompanyOrderField​

The possible fields to order companies by.

enum CompanyOrderField {
  CONTACT_COUNT
  CONVERSATION_COUNT
  CREATED_AT
  DOMAIN
  NAME
  UPDATED_AT
}

ConditionOperator​

The possible operators for folder conditions.

enum ConditionOperator {
  CONTAINS
  DOES_NOT_CONTAIN
  EQ
  GT
  GTEQ
  LT
  LTEQ
  NOT_EQ
}

ConditionOrderField​

The possible fields by which folder conditions can be ordered.

enum ConditionOrderField {
  CREATED_AT
  PARAM
  UPDATED_AT
}

ConditionParam​

The possible parameters for folder conditions.

enum ConditionParam {
  TAGS
  PRIORITY
  STARRED
  STATUS
  DELETED
  CHANNEL
  SNOOZE_STATE
  SNOOZE_UNTIL
  ASSIGNED_AGENT
  ASSIGNED_GROUP
  MENTIONS
  DRAFTS
  LAST_AGENT_MESSAGE_AT
  HOURS_SINCE_UPDATED
  HOURS_SINCE_STATUS_CHANGED
  HOURS_SINCE_NEW
  HOURS_SINCE_OPEN
  HOURS_SINCE_FOLLOW_UP
  HOURS_SINCE_PENDING
  HOURS_SINCE_CLOSED
  HOURS_SINCE_ASSIGNED
  HOURS_TILL_EXPIRES
  HOURS_SINCE_LAST_UNANSWERED_USER_MESSAGE
  INTERACTION_COUNT
  FOLLOWING_AGENTS
  CUSTOM_FIELD
}

ConditionSystem​

Represents the different condition systems an object can support.

enum ConditionSystem {
  FOLDER
  RULE
}

ContactOrderField​

The possible fields to order contacts by.

enum ContactOrderField {
  CREATED_AT
  COMPANY_NAME
  CONVERSATION_COUNT
  EMAIL
  JOB_TITLE
  LAST_SEEN_AT
  NAME
  UPDATED_AT
}

ContactRole​

The possible contact roles.

enum ContactRole {
  CUSTOMER
  COLLABORATOR
}

ContactType​

The possible types of contacts.

enum ContactType {
  lead
  contact
}

ConversationOrderField​

The possible fields by which conversations can be ordered.

enum ConversationOrderField {
  STATE
  STATE_CHANGED_AT
  UPDATED_AT
  LATEST_COLLABORATOR_COMMENT_AT
  LAST_UNANSWERED_USER_MESSAGE_AT
  DELETED_AT
  CREATED_AT
}

ConversationReplyState​

No description

enum ConversationReplyState {
  OPENED
  CLOSED
  PENDING
}

ConversationRestoreState​

The possible states of a conversation to be restored to.

enum ConversationRestoreState {
  UNREAD
  OPENED
  CLOSED
  SPAM
}

ConversationState​

The possible states of a conversation.

enum ConversationState {
  UNREAD
  OPENED
  CLOSED
  SNOOZED
  DELETED
  SPAM
  TRASH
}

ConversationType​

The possible types of conversations.

enum ConversationType {
  CHAT
  EMAIL
  FACEBOOK
  TWITTER
  WIDGET
}

CouponDuration​

The possible coupon durations.

enum CouponDuration {
  FOREVER
  ONCE
  REPEATING
}

CreditCardFunding​

The funding options for a credit card

enum CreditCardFunding {
  CREDIT
  DEBIT
  PREPAID
  UNKNOWN
}

CustomFieldCategoryType​

The possible types of custom field categories.

enum CustomFieldCategoryType {
  CONTACT
  COMPANY
  CHANNEL
}

CustomFieldFileContentDisposition​

The possible custom field file dispositions.

enum CustomFieldFileContentDisposition {
  inline
  attachment
}

CustomFieldHandleType​

The handle types available for custom fields.

enum CustomFieldHandleType {
  EMAIL
  FACEBOOK
  TWITTER
  LINKEDIN
  DOMAIN
  CUSTOM
  SHOPIFY
  FACEBOOK_PSID
  RECHARGE
}

CustomFieldIcon​

The icons available for custom fields.

enum CustomFieldIcon {
  AT
  AWARD
  BOOK
  BOOKS
  BUILDING
  CALENDAR
  CLOCK
  COINS
  COPY
  DOLLAR
  DROPDOWN
  EDIT
  EXTERNAL_LINK
  FACEBOOK
  FILE_EDIT
  FILE
  GIFT
  GLOBE
  GRADUATION
  HASHTAG
  HOURGLASS
  IMAGE
  INSTITUTION
  LANGUAGE
  LINE_CHART
  LINKEDIN
  LOCATION
  NETWORK
  NOTEBOOK
  PAGE
  PAPERCLIP
  PEN
  PEOPLE
  PERSON
  PHONE
  PIE_CHART
  PRESENT
  RECEIPT
  STOPWATCH
  TWITTER
  WINDOW
}

CustomFieldLinkScope​

Defines the scope in which a custom field is applicable, determining its availability across different channels.

enum CustomFieldLinkScope {
  GLOBAL
  CHANNEL
}

CustomFieldType​

The possible types of custom fields.

enum CustomFieldType {
  ADDRESS
  BOOLEAN
  DATE
  DROPDOWN
  FILE
  FIRST_SESSION
  IP_ADDRESS
  LATEST_SESSION
  LINK
  MULTI_LINE
  MONEY
  NUMBER
  SINGLE_LINE
  SUM
  USER_AGENT
  TIMEZONE
  MULTI_SELECT
}

customFieldValueUpdateMode​

The possible modes by which to update custom field values.

enum customFieldValueUpdateMode {
  APPEND
  REPLACE
}

DeleteMode​

The possible modes of deleted conversations.

enum DeleteMode {
  SOFT
  HARD
}

DiscountType​

The possible discount types.

enum DiscountType {
  SUBSCRIPTION
  ACCOUNT
}

DraftOrderField​

The possible fields by which drafts can be ordered.

enum DraftOrderField {
  CREATED_AT
  VERSION
  UPDATED_AT
}

DraftType​

No description

enum DraftType {
  REPLY
  REPLY_ALL
  NOTE
}

EmailMarketingIntegrationType​

No description

enum EmailMarketingIntegrationType {
  MAILCHIMP
  CAMPAIGN_MONITOR
  CONSTANT_CONTACT
}

EmailTemplateState​

The possible states of an EmailTemplate, determining its availability and usage within the system.

enum EmailTemplateState {
  ENABLED
  DISABLED
}

EmailTemplateTrigger​

The events that can trigger the use of an email template.

enum EmailTemplateTrigger {
  NEW_TICKET_NOTIFICATION
}

EncryptionType​

The type of encryption used for the connection.

enum EncryptionType {
  NONE
  SSL
}

EphemeralJobResultState​

No description

enum EphemeralJobResultState {
  PENDING
  COMPLETED
  FAILED
}

EventType​

The possible types of events.

enum EventType {
  AGENT_CHANGED
  CHANNEL_CHANGED
  CONTACT_CHANGED
  CONTACT_READ
  DELETED
  FOLLOWED_OR_UNFOLLOWED
  INTEGRATION_ADDED
  INTEGRATION_REMOVED
  INTEGRATION_EXTERNAL_CHANGE
  MERGED
  MESSAGE_CREATED
  RATED
  SNOOZED
  PRIORITY_CHANGED
  SHOPIFY_EXTERNAL_EVENT
  STATE_CHANGED
  SUBJECT_CHANGED
  TAGGED
  UNTAGGED
  TEAM_CHANGED
  UNDELETED
  UNSNOOZED
}

ExportOrderField​

The possible fields by which exports can be ordered.

enum ExportOrderField {
  REQUESTED_BY_ID
  STATE
  CREATED_AT
  COMPLETED_AT
}

ExportState​

The possible states of an export.

enum ExportState {
  REQUESTED
  QUEUED
  EXPORTING
  UPLOAdING
  COMPLETED
  CANCELLED
  FAILED
  DELETED
}

FolderMatchTypes​

The possible types of folder condition matches.

enum FolderMatchTypes {
  ANY
  ALL
}

FolderOrderField​

The possible fields by which folders can be ordered.

enum FolderOrderField {
  CREATED_AT
  NAME
  POSITION
  UPDATED_AT
}

FolderScope​

The types of resources this folder can be used for

enum FolderScope {
  DEFAULT
  CURRENT_USER
  ALL
}

FolderState​

The possible states of a folder.

enum FolderState {
  ACTIVE
  INACTIVE
  ALL
}

FolderType​

The types of resources this folder can be used for

enum FolderType {
  TICKET
  CHAT
  ALL
}

IntegrationProvider​

The possible integration providers.

enum IntegrationProvider {
  CHAT
  GITHUB
  GITHUB_LEGACY
  GOOGLE
  OPTIMIZECX
  HUBSPOT
  JIRA_CLOUD
  JIRA_SERVER
  MICROSOFT_OFFICE_365
  SALESFORCE
  SHOPIFY
  SHOPIFY_V2
  STRIPE
  TRELLO
  RECHARGE
}

KbRating​

The possible types of Knowledge Base article ratings.

enum KbRating {
  EMOJI
  UPVOTE
}

Operator​

Represents all available operators for various condition systems.

enum Operator {
  CONTAIN
  CONTAINS
  CONTAINS_WORDS
  DO_NOT_CONTAIN
  DOES_NOT_CONTAIN
  DOES_NOT_CONTAIN_WORDS
  DOMAIN_IS
  DOMAIN_IS_NOT
  ENDS_WITH
  EQ
  GT
  GTEQ
  IS
  IS_NOT
  LT
  LTEQ
  MATCHES
  NOT_EQ
  STARTS_WITH
}

OrderDirection​

The possible directions in which to order results.

enum OrderDirection {
  ASC
  DESC
}

PinnedSearchOrderField​

The possible fields by which pinned searches can be ordered.

enum PinnedSearchOrderField {
  POSITION
}

PlanState​

The possible plan states.

enum PlanState {
  TRIAL
  PAID
  EXPIRED
  CANCELED
}

PresenceStatusType​

The possible types of Live Chat presence statuses.

enum PresenceStatusType {
  ONLINE
  UNAVAILABLE
  OFFLINE
}

PricingModel​

The possible pricing models.

enum PricingModel {
  FLAT
  USAGE
}

PricingType​

The possible pricing types.

enum PricingType {
  KB
  INBOX
  ADDON
}

PricingUsageFrom​

The possible sources for determining quantity billed.

enum PricingUsageFrom {
  KBS
  CHANNELS
  USERS
  VIEWER_USERS
  MAILBOXES
  FLAT
}

ProtocolType​

The communication protocol used by the server.

enum ProtocolType {
  SMTP
  IMAP
}

PublishState​

The possible states of a Knowledge Base article.

enum PublishState {
  DRAFT
  WIP
  PUBLISHED
  DELETED
}

RatingEnum​

The possible types of Inbox message ratings.

enum RatingEnum {
  ANY
  AWESOME
  OK
  BAD
}

RestrictionType​

The possible restriction types, defining who has access to a resource or action.

enum RestrictionType {
  EVERYONE
  TEAMS
  ME
  AGENTS
}

RoomChannelTypeEnum​

The types of rooms in the groove system

enum RoomChannelTypeEnum {
  WIDGET
  SOCIAL
}

RoomKindType​

The possible types of Live Chat room kinds.

enum RoomKindType {
  BOT
  EXTERNAL
  INTERNAL
  ACCOUNT
  EXTERNAL_NEXT
}

RoomOrderField​

The possible fields by which Live Chat rooms can be ordered.

enum RoomOrderField {
  UPDATED_AT
  LAST_USER_MESSAGE_AT
  LAST_USER_OR_AGENT_MESSAGE_AT
  LAST_USER_OR_NOTE_MESSAGE_AT
  LAST_USER_AGENT_OR_NOTE_MESSAGE_AT
  LAST_UNANSWERED_USER_MESSAGE_AT
  EXPIRES_AT
}

RoomStateType​

The possible types of Live Chat room states.

enum RoomStateType {
  OPEN
  SNOOZED
  CLOSED
  SPAM
  TRASH
  MINE
  UNASSIGNED
}

RuleActionType​

The possible action types for rules.

enum RuleActionType {
  ADD_AGENTS_AS_FOLLOWERS
  ASSIGNEE_GROUP_ID
  ASSIGNEE_ID
  FORWARD_CONVERSATION
  LABEL
  LABELS
  MAILBOX
  NEXT_AVAILABLE_AGENT
  NEXT_AVAILABLE_AGENT_IN_GROUP
  PRIORITY
  REMOVE_ALL_LABELS
  REMOVE_LABEL
  SEND_EMAIL_TO_AGENTS
  SEND_IN_APP_NOTIFICATION_TO_AGENTS
  SEND_EMAIL_TO_REQUESTER
  SNOOZE_UNTIL
  STAR
  STATUS
  SEND_EMAIL_REPLY
  ADD_NOTE
  UNSNOOZE
  UNASSIGN
  SUBJECT
}

RuleConditionOperator​

The possible operators for rule conditions.

enum RuleConditionOperator {
  CONTAIN
  CONTAINS
  CONTAINS_WORDS
  DO_NOT_CONTAIN
  DOES_NOT_CONTAIN
  DOES_NOT_CONTAIN_WORDS
  DOMAIN_IS
  DOMAIN_IS_NOT
  ENDS_WITH
  GT
  GTEQ
  IS
  IS_NOT
  LT
  LTEQ
  MATCHES
  STARTS_WITH
}

RuleConditionParam​

The possible parameters for rule conditions.

enum RuleConditionParam {
  TO_EMAIL
  CC
  BCC
  FROM_EMAIL
  SUBJECT
  DESCRIPTION
  SUBJECT_OR_DESCRIPTION
  MESSAGE_CONTENT
  SUBJECT_OR_MESSAGE_CONTENT
  CONTACT_NAME
  LABELS
  HAS_LABELS
  MAILBOX
  SOURCE
  STATUS
  PRIORITY
  AGENT_MESSAGE_COUNT
  ENDUSER_MESSAGE_COUNT
  COMMENTS_COUNT
  ATTACHMENTS
  ASSIGNEE
  ASSIGNED
  TIME_DAY_OF_WEEK
  TIME_CURRENT
  DATE_CURRENT
  TIME_BUSINESS_HOURS
  ENDUSER_UNREPLIED
  AGENT_UNREPLIED
  LAST_MESSAGE_SENDER_TYPE
  CUSTOM_FIELD
}

RuleMatchTypes​

The possible types of rule condition matches.

enum RuleMatchTypes {
  ANY
  ALL
}

RuleOrderField​

The possible fields by which rules can be ordered.

enum RuleOrderField {
  CREATED_AT
  NAME
  POSITION
  UPDATED_AT
}

RuleState​

The possible states of a rule.

enum RuleState {
  ACTIVE
  INACTIVE
}

RuleTriggerType​

The possible types for rule triggers.

enum RuleTriggerType {
  CREATED
  UPDATED
  CREATED_BY_AGENT
  MAILBOX_CHANGED
  NEW_INBOUND_MESSAGE
  NEW_OUTBOUND_MESSAGE
  NEW_NOTE
  AGENT_MENTIONED
  AGENT_ASSIGNED
  AGENT_UNASSIGNED
  ASSIGNEE_CHANGED
  CONVERSATION_CLOSED
  CONVERSATION_OPENED
  CONVERSATION_TRASHED
  CONVERSATION_UNTRASHED
  CONVERSATION_SPAMMED
  CONVERSATION_SNOOZED
  CONVERSATION_RATED
  CONVERSATION_AUTOMATIC_UNSNOOZED
  LABEL_ADDED
  LABEL_REMOVED
  CUSTOM_FIELD_CHANGED
}

ScheduleType​

The possible schedule parameters for rules.

enum ScheduleType {
  IMMEDIATELY
  AFTER
  ON_DAY
  ON_NEXT
  BEFORE_MONTH
  BUSINESS_HOURS_START
  BUSINESS_HOURS_END
  AFTER_BUSINESS_HOURS_START
  BEFORE_BUSINESS_HOURS_END
  AFTER_BUSINESS_HOURS
}

SetupIntentStatus​

The possible status types for setup intents.

enum SetupIntentStatus {
  REQUIRES_PAYMENT_METHOD
  REQUIRES_CONFIRMATION
  REQUIRES_ACTION
  PROCESSING
  CANCELED
  SUCCEEDED
}

SetupIntentUsage​

The possible usage types for setup intents.

enum SetupIntentUsage {
  ON_SESSION
  OFF_SESSION
}

ShopifyChangeType​

No description

enum ShopifyChangeType {
  ORDER_CANCELED
  ORDER_CREATED
  ORDER_DUPLICATED
  ORDER_REFUNDED
  DRAFT_ORDER_INVOICE_SENT
}

TagOrderField​

The possible fields by which tags can be ordered.

enum TagOrderField {
  COLOR
  COUNT
  CONVERSATION_COUNT
  CREATED_AT
  NAME
  UPDATED_AT
  LAST_USED_AT
  CREATOR_ID
}

TagState​

The possible states of a tag.

enum TagState {
  ANY
  USED
  UNUSED
}

TeamOrderField​

The possible fields by which teams can be ordered.

enum TeamOrderField {
  CREATED_AT
  NAME
  SIZE
  UPDATED_AT
}

ThreadingType​

The possible threading types that define how messages are grouped or handled in a channel.

enum ThreadingType {
  LEGACY
  REGULAR
  SUBJECT
  GMAIL
  NONE
}

WebhookEvent​

Events that can trigger webhooks.

enum WebhookEvent {
  TICKET_STARTED
  TICKET_OPENED
  TICKET_STATE_CHANGED
  TICKET_CLOSED
  TICKET_ASSIGNED
  TICKET_PRIORITY_CHANGED
  TICKET_DELETED
  TICKET_MOVED
  TICKET_TAGGED
  TICKET_UNTAGGED
  TICKET_MERGED
  CUSTOMER_ADDED
  AGENT_INVITED
  AGENT_ARCHIVED
  NOTE_ADDED
  NOTE_CHANGED
  AGENT_REPLIED
  CUSTOMER_REPLIED
  MESSAGE_RATED
  MESSAGE_READ
}

WebhookState​

Possible webhook states.

enum WebhookState {
  ACTIVE
  INACTIVE_URL
  INACTIVE_CREATOR
}

WidgetChannelType​

No description

enum WidgetChannelType {
  WIDGET
  SOCIAL
}

WidgetKind​

No description

enum WidgetKind {
  FACEBOOK
  INSTAGRAM
}

WidgetStatus​

No description

enum WidgetStatus {
  CONNECTED
  DISCONNECTED
}