Enums

AuthState#

No description

enum AuthState {
CHALLENGE
SUCCESS
}

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.

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.

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.

EmailMarketingIntegrationType#

No description

enum EmailMarketingIntegrationType {
MAILCHIMP
CAMPAIGN_MONITOR
CONSTANT_CONTACT
}

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.

OrderDirection#

The possible directions in which to order results.

enum OrderDirection {
ASC
DESC
}

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.

Edit this page

On this page