Enums

AccountState#

The possible account states.

enum AccountState {
PRECREATED
TRIAL
OPEN
EXPIRED
CLOSED
}

AgentNotificationPreferenceNotificationNamespaceType#

Possible notification preference namespace

enum AgentNotificationPreferenceNotificationNamespaceType {
notifications
}

AgentNotificationPreferenceNotificationType#

Possible notification types

enum AgentNotificationPreferenceNotificationType {
EMAIL
WEB
DESKTOP
}

Values#

  • EMAIL Email notification type.

  • DESKTOP Web browser desktop notification type.

AgentOrderField#

The possible fields by which agents can be ordered.

enum AgentOrderField {
CREATED_AT
NAME
UPDATED_AT
ASSIGNMENT_COUNT
}

Values#

  • CREATED_AT Orders by the date that the agent was created.

  • NAME Orders by the agent name.

  • UPDATED_AT Orders by the date that the agent was last updated.

  • ASSIGNMENT_COUNT Orders by the number of times you assigned them to a conversation.

AgentRole#

The possible agent roles.

enum AgentRole {
OWNER
ADMIN
AGENT
}

Values#

  • OWNER The owner of the account.

  • ADMIN A user with administrative privileges.

  • AGENT A user with a login.

AgentState#

The possible states of an agent.

enum AgentState {
INVITED
ACTIVE
ARCHIVED
}

Values#

  • INVITED The agent has been invited but has not yet accepted.

  • ACTIVE The agent accepted the invitation and is not archived.

  • ARCHIVED The agent was archived.

AgentTwoFactorAuthStatus#

The possible status of an agent's 2fa.

enum AgentTwoFactorAuthStatus {
LOCKED
CONFIRMED
ENABLED
DISABLED
}

Values#

  • LOCKED The agent has a locked 2fa.

  • CONFIRMED The agent has a confirmed 2fa.

  • ENABLED The agent has an enabled 2fa.

  • DISABLED The agent has a disabled 2fa.

AiConversationSuggestionType#

The possible types of conversation's AI suggestion.

enum AiConversationSuggestionType {
TAGS
SENTIMENT
SUMMARY
}

Values#

  • TAGS Tags suggestion.

  • SENTIMENT Sentiment priority.

  • SUMMARY Summary suggestion.

ArticleOrderField#

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

enum ArticleOrderField {
AVERAGE_RATINGS
TITLE
UPDATED_AT
}

Values#

  • AVERAGE_RATINGS Orders by the average rating of the article.

  • TITLE Orders by the article title.

  • UPDATED_AT Orders by the date that the article was last updated.

ArticleRatingTypes#

The possible types of Knowledge Base article ratings.

enum ArticleRatingTypes {
EMOJI
UPVOTE
}

Values#

  • EMOJI Allows rating with a scale of 4 emojis.

  • UPVOTE Allows rating with a thumbs up or a thumbs down.

AttachmentScanReportStatus#

The possible types of scan report status.

enum AttachmentScanReportStatus {
OK
FOUND
WARNING
PENDING
FAILED
}

Values#

  • OK Nothing was found.

  • WARNING A warning was found in the database.

  • PENDING Scan is still in progress, fetch the scan again.

AttachmentType#

The possible types of Attachments.

enum AttachmentType {
ATTACHMENT
API_ATTACHMENT
MAILED_ATTACHMENT
MALICIOUS_ATTACHMENT
SUSPICIOUS_ATTACHMENT
UPLOADED_ATTACHMENT
}

Values#

  • ATTACHMENT Simple attachment.

  • API_ATTACHMENT API attachment.

  • MAILED_ATTACHMENT Incoming mail attachment.

  • UPLOADED_ATTACHMENT Uploaded attachment.

AttachmentsConversationTypeEnum#

No description

enum AttachmentsConversationTypeEnum {
ALL
CURRENT
}

Values#

  • ALL All conversations.

  • CURRENT The current conversation.

AuthState#

No description

enum AuthState {
CHALLENGE
SUCCESS
}

BodyPartTypeEnum#

No description

enum BodyPartTypeEnum {
TEXT
QUOTED
}

Values#

  • TEXT Text part.

  • QUOTED Quoted text part.

CannedReplyOrderField#

The possible fields by which canned replies can be ordered.

enum CannedReplyOrderField {
CREATED_AT
NAME
CATEGORY
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the canned reply was created.

  • NAME Orders by the canned reply name.

  • CATEGORY Orders by the canned reply category name.

  • UPDATED_AT Orders by the date that the canned reply was last updated.

CategoryOrderField#

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

enum CategoryOrderField {
CREATED_AT
NAME
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the canned reply category was created.

  • NAME Orders by the canned reply category name.

  • UPDATED_AT Orders by the date that the canned reply category was last updated.

ChannelOrderField#

The possible fields by which channels can be ordered.

enum ChannelOrderField {
CREATED_AT
NAME
POSITION
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the channel was created.

  • NAME Orders by the channel name.

  • POSITION Orders by the agent's preferred row order for the channel.

  • UPDATED_AT Orders by the date that the channel was last updated.

ChannelState#

The possible states of a channel.

enum ChannelState {
UNCONFIRMED
DEMO
CONFIRMED
ACTIVE
}

Values#

  • UNCONFIRMED The initial value.

  • CONFIRMED The channel has been confirmed by the owner.

  • ACTIVE A message has been received on the channel.

ChannelType#

The possible types of channels.

enum ChannelType {
ASYNC
REALTIME
}

Values#

  • ASYNC The primary style of communication in the channel is asynchronous.

  • REALTIME The primary style of communication in the channel is synchronous.

CompanyOrderField#

The possible fields to order companies by.

enum CompanyOrderField {
CONTACT_COUNT
CONVERSATION_COUNT
CREATED_AT
DOMAIN
NAME
UPDATED_AT
}

Values#

  • CONTACT_COUNT Orders by the number of contacts within the company.

  • CONVERSATION_COUNT Orders by the number of conversations within the company.

  • CREATED_AT Orders by the date that the company was created.

  • DOMAIN Orders by the company's primary domain.

  • NAME Orders by the company name.

  • UPDATED_AT Orders by the date that the company was last updated.

ConditionOperator#

The possible operators for folder conditions.

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

Values#

  • CONTAINS The parameter appears in the list.

  • DOES_NOT_CONTAIN The parameter does not appear in the list.

  • EQ The parameter is equal to the value.

  • GT The parameter is greater than the value.

  • GTEQ The parameter is greater than or equal to the value.

  • LT The parameter is less than the value.

  • LTEQ The parameter is less than or equal to the value.

  • NOT_EQ The parameter is not equal to the value.

ConditionOrderField#

The possible fields by which folder conditions can be ordered.

enum ConditionOrderField {
CREATED_AT
PARAM
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the folder was created.

  • PARAM Orders by the parameter name.

  • UPDATED_AT Orders by the date that the folder was last updated.

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
}

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
}

Values#

  • CREATED_AT Orders by the date that the contact was created.

  • COMPANY_NAME Orders by the name of the contact's company.

  • CONVERSATION_COUNT Orders by the number of conversations of the contact.

  • EMAIL Orders by the contact's primary email.

  • JOB_TITLE Orders by the contact's job title.

  • LAST_SEEN_AT Orders by the date that the agent was last seen.

  • NAME Orders by the contact name.

  • UPDATED_AT Orders by the date that the contact was last updated.

ContactRole#

The possible contact roles.

enum ContactRole {
CUSTOMER
COLLABORATOR
}

Values#

  • CUSTOMER The contact is the main customer of the conversation.

ContactType#

The possible types of contacts.

enum ContactType {
lead
contact
}

Values#

  • lead The contact is a lead.

  • contact The contact is a 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
}

Values#

  • STATE Orders by the state of the conversation.

  • UPDATED_AT Orders by the date the conversation was last updated by a user.

  • LAST_UNANSWERED_USER_MESSAGE_AT Orders by the date of the last unanswered user message.

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
}

Values#

  • UNREAD The conversation is new or contains unread messages.

  • OPENED The conversation has been viewed by an agent.

  • CLOSED The conversation is closed.

  • SPAM The conversation is marked as spam.

ConversationState#

The possible states of a conversation.

enum ConversationState {
UNREAD
OPENED
CLOSED
SNOOZED
DELETED
SPAM
}

Values#

  • UNREAD The conversation is new or contains unread messages.

  • OPENED The conversation has been viewed by an agent.

  • CLOSED The conversation is closed.

  • SNOOZED The conversation is snoozed.

  • SPAM The conversation is marked as spam.

ConversationType#

The possible types of conversations.

enum ConversationType {
CHAT
EMAIL
FACEBOOK
TWITTER
WIDGET
}

Values#

  • CHAT A chat conversation.

  • EMAIL An email conversation.

  • FACEBOOK A Facebook conversation.

  • TWITTER A Twitter conversation.

  • WIDGET A Widget conversation.

CouponDuration#

The possible coupon durations.

enum CouponDuration {
FOREVER
ONCE
REPEATING
}

Values#

  • FOREVER Applies to all charges from a subscription with this coupon applied.

  • ONCE Applies to the first charge from a subscription with this coupon applied.

  • REPEATING Applies to charges in the first duration_in_months months from a subscription with this coupon applied.

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
}

Values#

  • CONTACT The category is associated with a contact.

  • COMPANY The category is associated with a company.

CustomFieldFileContentDisposition#

The possible custom field file dispositions.

enum CustomFieldFileContentDisposition {
inline
attachment
}

Values#

  • attachment The file should be downloaded.

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
FACEBOOK
FILE
GIFT
GLOBE
GRADUATION
HASHTAG
HOURGLASS
INSTITUTION
IMAGE
LANGUAGE
LINE_CHART
LINKEDIN
LOCATION
NETWORK
NOTEBOOK
PAGE
PEN
PEOPLE
PERSON
PHONE
PIE_CHART
PRESENT
RECEIPT
STOPWATCH
TWITTER
WINDOW
}

Values#

  • AT At icon.

  • AWARD Award icon.

  • BOOK Book icon.

  • BOOKS Books icon.

  • BUILDING Building icon.

  • CALENDAR Calendar icon.

  • CLOCK Clock icon.

  • COINS Coins icon.

  • COPY Copy icon.

  • DOLLAR Dollar icon.

  • FACEBOOK Facebook icon.

  • FILE File icon.

  • GIFT Gift icon.

  • GLOBE Globe icon.

  • GRADUATION Graduation icon.

  • HASHTAG Hashtag icon.

  • HOURGLASS Hourglass icon.

  • INSTITUTION Institution icon.

  • IMAGE Image icon.

  • LANGUAGE Language icon.

  • LINE_CHART Line chart icon.

  • LINKEDIN LinkedIn icon.

  • LOCATION Location icon.

  • NETWORK Network icon.

  • NOTEBOOK Notebook icon.

  • PAGE Page icon.

  • PEN Pen icon.

  • PEOPLE People icon.

  • PERSON Person icon.

  • PHONE Phone icon.

  • PIE_CHART Pie chart icon.

  • PRESENT Present icon.

  • RECEIPT Receipt icon.

  • STOPWATCH Stopwatch icon.

  • TWITTER Twitter icon.

  • WINDOW Window icon.

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
}

Values#

  • ADDRESS An address.

  • BOOLEAN A boolean.

  • DATE A date.

  • DROPDOWN A list of textual items.

  • FILE A file.

  • FIRST_SESSION The first session.

  • IP_ADDRESS An IP address.

  • LATEST_SESSION The Latest session.

  • LINK A link.

  • MULTI_LINE Multiple lines of text.

  • MONEY A money object.

  • NUMBER A number.

  • SINGLE_LINE A single line of text.

  • SUM A sum.

  • USER_AGENT A user agent.

  • TIMEZONE A time zone.

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
}

Values#

  • SOFT The conversation has been moved to trash.

  • HARD The conversation has been permanently deleted.

DiscountType#

The possible discount types.

enum DiscountType {
SUBSCRIPTION
ACCOUNT
}

Values#

  • SUBSCRIPTION Discount being used on this account was applied to the subscription.

  • ACCOUNT Discount being used on this account was applied to the account.

DraftOrderField#

The possible fields by which drafts can be ordered.

enum DraftOrderField {
CREATED_AT
VERSION
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the draft was created.

  • VERSION Orders by the draft version.

  • UPDATED_AT Orders by the date that the draft was last updated.

DraftType#

No description

enum DraftType {
REPLY
REPLY_ALL
NOTE
}

Values#

  • REPLY A draft of a reply to a conversation.

  • REPLY_ALL A draft of a reply to all participants in a conversation.

  • NOTE A draft of a note on a conversation.

EmailMarketingIntegrationType#

No description

enum EmailMarketingIntegrationType {
MAILCHIMP
CAMPAIGN_MONITOR
CONSTANT_CONTACT
}

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
}

Values#

  • AGENT_CHANGED The agent assigned to the conversation changed.

  • CHANNEL_CHANGED The channel of the conversation changed.

  • CONTACT_CHANGED The conversation was assigned to a different contact.

  • CONTACT_READ The contact read a message.

  • DELETED The conversation was deleted.

  • FOLLOWED_OR_UNFOLLOWED A follower was added or removed from the conversation.

  • INTEGRATION_ADDED An integration was added to the conversation.

  • INTEGRATION_REMOVED An integration was removed from the conversation.

  • INTEGRATION_EXTERNAL_CHANGE A change occurred on a linked integration.

  • MERGED A conversation was merged into this conversation.

  • MESSAGE_CREATED A new message was created in the conversation.

  • RATED A contact rated a message in the conversation.

  • SNOOZED The conversation was snoozed.

  • PRIORITY_CHANGED The priority of the conversation changed.

  • SHOPIFY_EXTERNAL_EVENT An external event happened on Shopify.

  • STATE_CHANGED The state of the conversation changed.

  • SUBJECT_CHANGED The subject of the conversation changed.

  • TAGGED A tag was added to the conversation.

  • UNTAGGED A tag was removed from the conversation.

  • TEAM_CHANGED The team assigned to the conversation changed.

  • UNDELETED The conversation was undeleted.

  • UNSNOOZED The conversation was unsnoozed.

FolderMatchTypes#

The possible types of folder condition matches.

enum FolderMatchTypes {
ANY
ALL
}

Values#

  • ANY Matches any condition.

  • ALL Matches all conditions.

FolderOrderField#

The possible fields by which folders can be ordered.

enum FolderOrderField {
CREATED_AT
NAME
POSITION
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the folder was created.

  • NAME Orders by the folder name.

  • POSITION Orders by the preferred row order.

  • UPDATED_AT Orders by the date that the folder was last updated.

FolderScope#

The types of resources this folder can be used for

enum FolderScope {
DEFAULT
ALL
}

Values#

  • DEFAULT Shows folders that you have access to.

FolderState#

The possible states of a folder.

enum FolderState {
ACTIVE
INACTIVE
ALL
}

Values#

  • ACTIVE The folder is enabled.

  • INACTIVE The folder is hidden.

FolderType#

The types of resources this folder can be used for

enum FolderType {
TICKET
CHAT
ALL
}

Values#

  • TICKET Folders for tickets.

  • CHAT Folders for chats.

  • ALL Folders for chats and tickets.

IntegrationProvider#

The possible integration providers.

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

Values#

  • CHAT Groove Chat integration.

  • GITHUB Github integration.

  • GOOGLE Google integration.

  • HUBSPOT Hubspot integration.

  • JIRA_CLOUD Jira Cloud integration.

  • JIRA_SERVER Jira Server integration.

  • SALESFORCE Salesforce integration.

  • SHOPIFY_V2 Shopify V2 integration.

  • STRIPE Stripe integration.

  • TRELLO Trello integration.

  • RECHARGE Recharge integration.

KbRating#

The possible types of Knowledge Base article ratings.

enum KbRating {
EMOJI
UPVOTE
}

Values#

  • EMOJI Allows rating with a scale of 4 emojis.

  • UPVOTE Allows rating with a thumbs up or a thumbs down.

OrderDirection#

The possible directions in which to order results.

enum OrderDirection {
ASC
DESC
}

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
}

Values#

  • FLAT Pricing that bills a fixed amount regardless of quantity.

PricingType#

The possible pricing types.

enum PricingType {
KB
INBOX
ADDON
}

Values#

  • KB Pricing that only give access to kb features.

  • INBOX Pricing that gives access to any groove feature.

  • ADDON Pricing that can extend the available features on an account.

PricingUsageFrom#

The possible sources for determining quantity billed.

enum PricingUsageFrom {
KBS
CHANNELS
USERS
VIEWER_USERS
MAILBOXES
FLAT
}

Values#

  • KBS Quantity is determined by looking at the number of published knowledge bases.

  • CHANNELS Quantity is determined by looking at the number of channels added to the account.

  • USERS Quantity is determined by looking at the number of Owner,Admin and Agent users added to the account.

  • VIEWER_USERS Quantity is determined by looking at the number of Owner,Admin and Agent users added to the account.

  • MAILBOXES Quantity is determined by looking at the number mailboxes added to the account.

PublishState#

The possible states of a Knowledge Base article.

enum PublishState {
DRAFT
WIP
PUBLISHED
DELETED
}

Values#

  • DRAFT The article is not yet published.

  • WIP The article is live but contains changes.

  • PUBLISHED The article is live.

  • DELETED The article is trashed.

RatingEnum#

The possible types of Inbox message ratings.

enum RatingEnum {
ANY
AWESOME
OK
BAD
}

Values#

  • ANY Any rating.

  • AWESOME An awesome rating.

  • OK An OK rating.

  • BAD A bad rating.

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
}

Values#

  • UPDATED_AT Orders by the date that the chat room was last updated.

  • LAST_USER_MESSAGE_AT Orders by the date of the last user message.

  • LAST_USER_OR_AGENT_MESSAGE_AT Orders by the date of the last message from an agent or user.

  • LAST_USER_OR_NOTE_MESSAGE_AT Orders by the date of the last agent note or user message.

  • LAST_USER_AGENT_OR_NOTE_MESSAGE_AT Orders by the date of the last message from an agent or user or agent note.

  • LAST_UNANSWERED_USER_MESSAGE_AT Orders by the date of the last unanswered user message.

  • EXPIRES_AT Orders by the expiration date.

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
}

RuleMatchTypes#

The possible types of rule condition matches.

enum RuleMatchTypes {
ANY
ALL
}

Values#

  • ANY Matches any condition.

  • ALL Matches all conditions.

RuleOrderField#

The possible fields by which rules can be ordered.

enum RuleOrderField {
CREATED_AT
NAME
POSITION
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the rule was created.

  • NAME Orders by the rule name.

  • POSITION Orders by the preferred row order.

  • UPDATED_AT Orders by the date that the rule was last updated.

RuleState#

The possible states of a rule.

enum RuleState {
ACTIVE
INACTIVE
}

Values#

  • ACTIVE The rule is enabled.

  • INACTIVE The rule is hidden.

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_OPENDED
CONVERSATION_TRASHED
CONVERSATION_UNTRASHED
CONVERSATION_SPAMMED
CONVERSATION_SNOOZED
CONVERSATION_RATED
CONVERSATION_AUTOMATIC_UNSNOOZED
LABEL_ADDED
LABEL_REMOVED
}

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
}

Values#

  • REQUIRES_PAYMENT_METHOD SetupIntent is created, it has a status of requires_payment_method1 until a payment method is attached.

  • REQUIRES_CONFIRMATION After the customer provides their payment information, the SetupIntent is ready to be confirmed.

  • REQUIRES_ACTION If the payment requires additional actions, such as authenticating with 3D Secure, the SetupIntent has a status of requires_action.

  • PROCESSING After required actions are handled, the SetupIntent moves to processing for asynchronous payment methods, such as bank debits.

  • SUCCEEDED A SetupIntent with a status of succeeded means that the payment flow it is driving is complete.

SetupIntentUsage#

The possible usage types for setup intents.

enum SetupIntentUsage {
ON_SESSION
OFF_SESSION
}

Values#

  • ON_SESSION The setup intent will be used during the current session like a shopping card checkout.

  • OFF_SESSION The setup intent will be used to setup a payment method which can be used with subscriptions.

ShopifyChangeType#

No description

enum ShopifyChangeType {
ORDER_CANCELED
ORDER_CREATED
ORDER_DUPLICATED
ORDER_REFUNDED
DRAFT_ORDER_INVOICE_SENT
}

Values#

  • ORDER_CANCELED An order was canceled.

  • ORDER_CREATED An order was created.

  • ORDER_DUPLICATED An order was duplicated.

  • ORDER_REFUNDED An order was refunded.

  • DRAFT_ORDER_INVOICE_SENT An invoice was sent for a draft order.

TagOrderField#

The possible fields by which tags can be ordered.

enum TagOrderField {
COLOR
COUNT
CREATED_AT
NAME
UPDATED_AT
LAST_USED_AT
CREATOR_ID
}

Values#

  • COLOR Orders by the tag color code.

  • COUNT Orders by the the number of times the tag is used.

  • CREATED_AT Orders by the date that the tag was created.

  • NAME Orders by the tag name.

  • UPDATED_AT Orders by the date that the tag was last updated.

  • LAST_USED_AT Orders by the last time the tag was used.

  • CREATOR_ID Orders by the creator id.

TagState#

The possible states of a tag.

enum TagState {
ANY
USED
UNUSED
}

Values#

  • ANY Any tag, regardless of how many conversations it has been applied to.

TeamOrderField#

The possible fields by which teams can be ordered.

enum TeamOrderField {
CREATED_AT
NAME
SIZE
UPDATED_AT
}

Values#

  • CREATED_AT Orders by the date that the team was created.

  • NAME Orders by the team name.

  • SIZE Orders by the number of agents in the team.

  • UPDATED_AT Orders by the date that the team was last updated.

WidgetChannelType#

No description

enum WidgetChannelType {
WIDGET
SOCIAL
}

Values#

  • WIDGET A regular widget.

  • SOCIAL A social widget.

WidgetKind#

No description

enum WidgetKind {
FACEBOOK
INSTAGRAM
}

Values#

  • FACEBOOK A facebook widget.

  • INSTAGRAM An instagram widget.

WidgetStatus#

No description

enum WidgetStatus {
CONNECTED
DISCONNECTED
}

Values#

  • CONNECTED The widget is connected.

  • DISCONNECTED The widget is disconnected.

Edit this page

On this page