Messaging

Conversations, messages, drafts, contact methods, and templates.

Queries

contactMethods

Lists ContactMethods

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • byStatus (ContactMethodStatusFilter) — The status of the ContactMethod to filter results by
  • byType (ContactMethodTypeFilter) — The ContactMethodType to filter results by
  • byTypes ([ContactMethodTypeFilter!]) — An array of ContactMethodTypes to filter results by
  • contact (String) — A contact to filter results by
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortContactMethodsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: ContactMethodConnection! — A connection to a list of items.

contactMethodsByIds

A list of ContactMethods by IDs

Arguments

  • ids ([ID!]!) — The IDs of the ContactMethods

Returns: [ContactMethod]! — A phone number or email address to send messages

conversation

A single Conversation by ID

Arguments

  • id (ID!) — The unique identifier of the Conversation

Returns: Conversation

conversationsByIds

A list of Conversations by IDs

Arguments

  • ids ([ID!]!) — The IDs of the Conversations

Returns: [Conversation]!

draftRecipients

A list of Draft Recipients by a Draft ID

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • draftId (ID!) — The ID of the Draft
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)

Returns: DraftRecipientConnection! — A connection to a list of items.

draftsByIds

A list of Drafts by IDs

Arguments

  • ids ([ID!]!) — The IDs of the Drafts

Returns: [Draft]! — A draft from which a Message may be created

message

A single Message by ID

Arguments

  • id (ID!) — The unique identifier of the Message

Returns: Message — A message exchanged between a user in Endear & an external contact

messages

A list of Messages in a Conversation

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • conversationId (ID!) — The ID of the Conversation to fetch Messages
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • sortBy (SortMessagesBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: MessageConnection! — A connection to a list of items.

messagesByIds

A list of Messages by IDs

Arguments

  • ids ([ID!]!) — The IDs of the Messages

Returns: [Message]! — A message exchanged between a user in Endear & an external contact

searchConversations

Searches Conversations

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortConversationsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: ConversationConnection! — A connection to a list of items.

searchDrafts

Searches Drafts

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortDraftsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: DraftConnection! — A connection to a list of items.

searchMessages

Searches Messages

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortMessagesBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: MessageConnection! — A connection to a list of items.

searchTemplates

Searches Templates

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortTemplatesBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: TemplateConnection! — A connection to a list of items.

templatesByIds

A list of Templates by IDs

Arguments

  • ids ([ID!]!) — The IDs of the Templates

Returns: [Template]!

Objects

ContactMethod

A phone number or email address to send messages

Fields

  • created_at (DateTime!) — The date the ContactMethod was created
  • disabled_at (DateTime) — The date the ContactMethod was disabled
  • external_contact_address (String) — The external contact address of the ContactMethod
  • id (ID!) — The unique identifier of the ContactMethod
  • name (String!) — The name of the ContactMethod
  • type (ContactMethodType!) — The type of the ContactMethod
  • updated_at (DateTime!) — The date the ContactMethod was last updated

ContactMethodConnection

A connection to a list of items.

Fields

ContactMethodEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (ContactMethod) — The item at the end of the edge

Conversation

Fields

  • blocked_at (DateTime)
  • contact_method (ContactMethod!) — The ContactMethod that this Conversation is associated with
  • created_at (DateTime!)
  • current_participants ([User!]!) — The Users that are currently participating in this Conversation
  • custom_attributes ([ConversationCustomAttribute!]) — The custom attributes of the Conversation
  • customer (Customer) — The Customer associated with this Conversation
  • external_contact_address (ID!)
  • first_message (Message) — The first Message in this Conversation
  • id (ID!)
  • latest_message (Message) — The latest Message in this Conversation
  • latest_single_recipient_sent_or_scheduled_draft (Draft) — The most recently updated single-recipient Draft that has been sent or scheduled for this Conversation
  • messaging_subscription (MessagingSubscription) — The MessagingSubscription that this Conversation is associated with
  • name (String) — The name of the Conversation
  • past_participants ([User!]!) — The Users that have previously participated in this Conversation
  • show_as_unclaimed_for_onboarding (Boolean!)
  • status (ConversationStatus!)
  • status_updated_at (DateTime) — The timestamp when the status of the Conversation was updated
  • status_updated_by_user (User) — The User that last updated the status of the Conversation
  • summary (String) — The summary of the Conversation
  • type (ContactMethodType!) — The type of the Conversation
  • updated_at (DateTime!)
  • web_url (URL!) — The URL to the Conversation inside the web application — 🚧 Deprecated: No longer supported
  • whatsapp_status (WhatsappStatus) — WhatsApp status information for the conversation

ConversationBooleanCustomAttribute

Fields

  • boolean (ConversationBooleanCustomAttributeData!) — The boolean value of the ConversationCustomAttribute
  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated

ConversationBooleanCustomAttributeData

Fields

  • value (Boolean) — The value of the ConversationCustomAttribute

ConversationConnection

A connection to a list of items.

Fields

ConversationCustomAttributePage

Fields

  • name (String) — The name of the page
  • url (HTTPURL!) — The url of the page

ConversationDateCustomAttribute

Fields

  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • date (ConversationDateCustomAttributeData!) — The date value of the ConversationCustomAttribute
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated

ConversationDateCustomAttributeData

Fields

  • value (DateTime) — The value of the ConversationCustomAttribute

ConversationEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Conversation) — The item at the end of the edge

ConversationMoneyCustomAttribute

Fields

  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • money (ConversationMoneyCustomAttributeData!) — The money value of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated

ConversationMoneyCustomAttributeData

Fields

  • value (Money) — The value of the ConversationCustomAttribute

ConversationTextCustomAttribute

Fields

  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • text (ConversationTextCustomAttributeData!) — The text value of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated

ConversationTextCustomAttributeData

Fields

  • value (String) — The value of the ConversationCustomAttribute

ConversationUrlCustomAttribute

Fields

  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated
  • url (ConversationUrlCustomAttributeData!) — The url value of the ConversationCustomAttribute

ConversationUrlCustomAttributeData

Fields

Draft

A draft from which a Message may be created

Fields

  • body_html (String!) — An HTML version of the Draft
  • body_text (String!) — A plaintext version of the Draft
  • body_text_preview (String!) — A preview of the Draft
  • body_text_summary (String!) — A summary version of the Message
  • cc ([String!]) — The cc addresses of the Draft
  • contact_method (ContactMethod) — The ContactMethod that will be used to send this Draft
  • contents ([DraftContent!]!) — The contents of the Draft
  • created_at (DateTime!) — The date and time at which the Draft was created
  • creator (User!) — The User who created the Draft
  • deleted_at (DateTime) — The time at which the Draft was deleted
  • id (ID!) — The ID of the Draft
  • in_reply_to_conversation (Conversation) — The Conversation this Draft is in reply to
  • in_reply_to_thread (Thread) — The Thread this Draft is in reply to
  • local_message_created_at (DateTime) — The time at which the local message was created
  • local_message_id (ID) — The local ID of the Draft
  • recipients (DraftRecipientConnection!) — The recipients of the Draft
  • scheduled_at (DateTime) — The time at which the Draft is scheduled to be sent
  • sending_at (DateTime) — The time at which the Draft transitioned to a status of sending
  • sending_failed_at (DateTime) — The time at which the Draft transitioned to a status of sending_failed
  • sent_at (DateTime) — The time at which the Draft transitioned to a status of sent
  • status (DraftStatus!) — The status of the Draft
  • subject (NonEmptyString) — The subject of the Draft
  • submitted_at (DateTime) — The time at which the Draft was submitted to be sent or scheduled
  • team (Team!)
  • text_direction (TextDirection!) — The text direction of the Draft
  • type (ContactMethodType!) — The type of ContactMethod that the Draft will be sent with
  • updated_at (DateTime!) — The date and time at which the Draft was last updated
  • web_url (URL!) — The URL to the Draft inside the web application — 🚧 Deprecated: No longer supported

DraftConnection

A connection to a list of items.

Fields

DraftEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Draft) — The item at the end of the edge

DraftFileContent

Fields

  • file (DraftFileContentData!)
  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to

DraftFileContentData

Fields

  • asset (Asset) — The Asset of the file
  • download_url (URL!) — A link to download the file
  • mime_type (String) — The mime type of the file
  • source_url (URL) — The source URL of the file
  • title (String!) — The title of the file
  • url (URL!) — The source URL of the file — 🚧 Deprecated: Use download_url instead

DraftImageContent

Fields

  • id (ID!) — The ID of the Content
  • image (DraftImageContentData!)
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to

DraftImageContentData

Fields

  • asset (Asset) — The Asset of the image
  • display_width (PositiveInt) — The display width of the image
  • external_link_url (URL) — An optional external link URL for the image
  • height (PositiveInt) — The height of the image
  • mime_type (String) — The mime type of the image
  • preview_url (URL!) — The preview URL of the image
  • source_url (URL) — The source URL of the image
  • title (String!) — The title of the image
  • url (URL!) — The source URL of the image — 🚧 Deprecated: Use preview_url instead
  • width (PositiveInt) — The width of the image

DraftRecipient

A potential recipient of a draft

Fields

  • customer (Customer) — An Endear customer associated to this DraftRecipient
  • email_address (String) — The email address of the DraftRecipient
  • id (ID!) — The ID of the DraftRecipient
  • phone_number (String) — The phone number of the DraftRecipient

DraftRecipientConnection

A connection to a list of items.

Fields

DraftRecipientEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (DraftRecipient) — The item at the end of the edge

DraftStoryContent

Fields

  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • story (DraftStoryContentData!)
  • template_id (ID) — The ID of Template to attribute the content to

DraftStoryContentData

Fields

  • link_url (URL!) — A URL to view the story — 🚧 Deprecated: Use view_url instead
  • preview_url (URL!) — The thumbnail URL of the story
  • story (Story!) — The Story of the story
  • title (String!) — The title of the story
  • url (URL!) — The source URL of the story — 🚧 Deprecated: Use link_url instead
  • view_url (URL!) — A URL to view the story

DraftTextContent

Fields

  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to
  • text (DraftTextContentData!)

DraftTextContentData

Fields

  • html (String!) — The html body of the text content
  • plain_text (String!) — The plain text of the text content

DraftUnsubscribeContent

Fields

  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to
  • unsubscribe (DraftUnsubscribeContentData!)

DraftUnsubscribeContentData

Fields

  • interpolated_text (String) — The interpolated text of the unsubscribe message
  • link_text (String) — The linked text of the unsubscribe message
  • message_text (String) — The message text of the unsubscribe message

DraftVideoContent

Fields

  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to
  • video (DraftVideoContentData!)

DraftVideoContentData

Fields

  • asset (Asset) — The Asset of the video
  • display_width (PositiveInt) — The display width of the video
  • height (PositiveInt) — The height of the video
  • mime_type (String) — The mime type of the video
  • preview_url (URL) — The thumbnail URL of the video
  • source_url (URL) — The source URL of the video
  • title (String!) — The title of the video
  • url (URL!) — The source URL of the video — 🚧 Deprecated: Use watch_url instead
  • watch_url (URL!) — A link to view the video
  • width (PositiveInt) — The width of the video

Message

A message exchanged between a user in Endear & an external contact

Fields

  • auto_response_detected (Boolean!) — Whether the Message is an automatic reply
  • body_html (String!) — An HTML version of the Message
  • body_markdown (String!) — A markdown version of the Message
  • body_text (String!) — An SMS-text version of the Message
  • body_text_preview (String!) — A preview of the Message
  • campaign (Campaign) — If the message was created by a Campaign, the Campaign
  • campaign_draft (CampaignDraft) — The Campaign Draft that originated this message, if message is part of a Campaign
  • contact_method (ContactMethod!) — The ContactMethod used to send or receive the Message
  • conversation (Conversation!) — The Conversation the Message belongs to
  • created_at (DateTime!) — The date the Message was created
  • delivered_at (DateTime) — The date the Message was delivered
  • direction (MessageDirection!) — Whether the Message was sent (outbound) or received (inbound)
  • draft (Draft) — The Draft that was used to create the Message
  • expiration_reason (MessageExpirationReason) — The reason the Message expired
  • expired_at (DateTime) — The date the Message expired
  • external_contact_address (ID!) — The email address or phone number of the external contact
  • fail_reason (MessageFailReason) — The reason the Message failed to send
  • failed_at (DateTime) — The date the Message failed to send
  • first_clicked_at (DateTime) — The date when the Message was first clicked
  • first_inbound_reply (Message) — The first inbound reply to this Message
  • first_opened_at (DateTime) — The date when the Message was first opened or read
  • first_outbound_reply (Message) — The first outbound reply to this Message
  • first_reply (Message) — The first reply to this Message
  • id (ID!) — The unique identifier of the Message
  • in_reply_to (Message) — The Message this Message is in reply to
  • is_opt_out_message (Boolean!) — Whether the Message is an opt-out message
  • is_reply (Boolean!) — Whether the Message is a reply
  • last_clicked_at (DateTime) — The date when the Message was last clicked
  • last_inbound_reply (Message) — The last inbound reply to this Message
  • last_opened_at (DateTime) — The date when the Message was last opened or read
  • last_opened_at_for_reporting (DateTime) — The date when the Message was last opened or read
  • last_outbound_reply (Message) — The last outbound reply to this Message
  • last_reply (Message) — The last reply to this Message
  • latest_reply (Message) — The latest reply to the Message — 🚧 Deprecated: Use last_reply instead
  • messaging_application (MessagingApplication) — The MessagingApplication that created the Message
  • permanently_redacted_at (DateTime) — The date the Message was permanently redacted
  • provider_fail_reason (String) — The reason the Message failed to send from the provider
  • redacted_at (DateTime) — The date the Message was redacted
  • sender_messaging_application (MessagingApplication) — The MessagingApplication that sent the Message
  • sent_as (User) — The User that sent the Message was sent as
  • sent_at (DateTime) — The date the Message was sent
  • sent_from_team (Team) — The Team that sent the Message was sent from
  • sent_or_created_at (DateTime!) — The date the Message was sent or created (if not sent)
  • source_body_html (String) — The original body of an inbound Message (null on outbound messages)
  • status (MessageStatus!) — The delivery status of the Message
  • subject (NonEmptyString) — The subject line of the Message (if any)
  • team (Team) — The Team that sent the Message was sent from — 🚧 Deprecated: Use Message.sent_from_team instead
  • template (Template) — The Template that was used to create the Message
  • thread (Thread) — The Thread this Message is in
  • ttl_expires_at (DateTime) — The date when the ability to reply to the message expires
  • type (ContactMethodType!) — The type of the Message
  • updated_at (DateTime!) — The date the Message was last updated
  • utm_code (String) — The UTM code of the Message
  • via (MessageSentVia!) — The method by which the Message was sent
  • web_url (URL!) — The URL to the Message inside the web application — 🚧 Deprecated: No longer supported
  • whatsapp_message_type (WhatsAppMessageType) — The type of WhatsApp message

MessageAttribution

A connection between a Message and an OrderAttribution

Fields

  • attributable_amount_split (Money!) — The total purchase amount attributed to the Messsage (accounting for splits)
  • created_at (DateTime!) — The date the MessageAttribution was created
  • days_to_convert (Int!) — The number of days between the Message being sent and the Order being created
  • deleted_at (DateTime) — The date the MessageAttribution was deleted
  • id (ID!) — The unique identifier of the MessageAttribution
  • is_clicked_before_conversion (Boolean!) — Whether the Message was clicked before the Order was created
  • is_opened_before_conversion (Boolean!) — Whether the Message was opened before the Order was created
  • is_replied_to_before_conversion (Boolean!) — Whether the Message was replied to before the Order was created
  • manually_excluded_at (DateTime) — The date the OrderAttribution was manually excluded
  • message (Message!) — The Message associated to the MessageAttribution
  • updated_at (DateTime!) — The date the MessageAttribution was last updated

MessageConnection

A connection to a list of items.

Fields

MessageEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Message) — The item at the end of the edge

MessagingApplication

The MessagingApplication for the Message

Fields

  • external_message_id (ID) — The external ID of the Message
  • integration (Integration) — The Integration for the MessagingApplication
  • type (MessagingApplicationType!) — The type of the MessagingApplication

Template

Fields

TemplateConnection

A connection to a list of items.

Fields

TemplateEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Template) — The item at the end of the edge

Thread

Fields

WhatsappStatus

WhatsApp status information for a conversation

Fields

  • consent_expiration_notified_at (DateTime) — When the consent expiration notification was sent
  • opt_in_expires_at (DateTime) — When the WhatsApp session TTL expires
  • opt_in_initiated_at (DateTime) — When the opt-in process was initiated
  • opt_in_prompt_message (Message) — The prompt message that was sent
  • opt_in_prompt_sent_at (DateTime) — When the opt-in prompt was sent

Interfaces

ConversationCustomAttributeInterface

Fields

  • created_at (DateTime!) — The date and time the ConversationCustomAttribute was created
  • key (ID!) — The key of the ConversationCustomAttribute
  • label (String!) — The label of the ConversationCustomAttribute
  • updated_at (DateTime!) — The date and time the ConversationCustomAttribute was last updated

Implemented by

DraftContentInterface

Fields

  • id (ID!) — The ID of the Content
  • in_signature (Boolean!) — Whether the Content is in the signature
  • initial (Boolean!) — Whether the Content is the initial Content
  • template_id (ID) — The ID of Template to attribute the content to

Implemented by

Unions

ConversationCustomAttribute

Possible types

DraftContent

Possible types

Enums

ContactMethodStatusFilter

The status of the ContactMethod to filter results by

Values

  • ACTIVE
  • ALL
  • DISABLED

ContactMethodType

Values

  • EMAIL
  • LIVE_CHAT
  • SMS
  • WHATSAPP

ContactMethodTypeFilter

The type of the ContactMethod to filter results by

Values

  • ALL
  • EMAIL
  • INBOUND
  • LIVE_CHAT
  • OUTBOUND
  • SMS
  • WHATSAPP

ConversationStatus

Values

  • BLOCKED
  • CLOSED
  • INACTIVE
  • OPEN

DraftStatus

Values

  • CREATED
  • SCHEDULED
  • SENDING
  • SENDING_FAILED
  • SENT

LimitSmsDraftsBy

Values

  • CHARACTERS
  • SEGMENTS

MessageDirection

Values

  • INBOUND
  • OUTBOUND

MessageExpirationReason

The reason the message was expired

Values

  • NO_OPT_IN_AFTER_TIMEOUT
  • OPT_IN_PROMPT_MESSAGE_CHANGED

MessageFailReason

The reason the message failed

Values

  • BOUNCE
  • CONTACT_METHOD_DISABLED
  • CONTENT_SIZE_EXCEEDED
  • FRAUD_VERIFICATION_INCOMPLETE
  • GEO_PERMISSION
  • HARD_BOUNCE
  • INVALID_MESSAGE_BODY
  • INVALID_RECIPIENT_CONTACT
  • INVALID_SENDER_CONTACT
  • MISSING_OR_DELETED_ASSETS
  • MMS_NOT_SUPPORTED
  • PREVIOUSLY_UNSUBSCRIBED
  • QUIET_HOURS
  • RESTRICTED_DESIGNATION
  • SMS_NOT_SUPPORTED
  • SPAM_COMPLAINT
  • UNKNOWN_ERROR
  • UNSUPPORTED_MEDIA_TYPE
  • WHATSAPP_BUSINESS_MANAGER_ERROR
  • WHATSAPP_INVALID_MESSAGE_RECIPIENT
  • WHATSAPP_MARKETING_REJECTION
  • WHATSAPP_PROMPT_RECENTLY_SENT

MessageSentVia

Values

  • EMAIL
  • LIVE_CHAT
  • SMS
  • WHATSAPP

MessageStatus

Values

  • AWAITING_OPT_IN
  • CREATED
  • DELIVERED
  • EXPIRED
  • FAILED
  • SENT

MessagingApplicationType

Values

  • API
  • GORGIAS
  • KUSTOMER
  • MOBILE
  • SHOPIFY_POS
  • WEB

SortContactMethodsBy

The available keys to sort ContactMethods

Values

  • CREATED_AT
  • NAME
  • UPDATED_AT

SortConversationsBy

The available keys to sort Conversations

Values

  • CREATED_AT
  • LAST_MESSAGE_AT
  • STATUS
  • UPDATED_AT

SortDraftsBy

The available keys to sort Drafts

Values

  • CREATED_AT
  • SCHEDULED_AT
  • STATUS
  • UPDATED_AT

SortMessagesBy

The available keys to sort Messages

Values

  • CREATED_AT
  • UPDATED_AT

SortTemplatesBy

The available keys to sort Templates

Values

  • CREATED_AT
  • CREATOR
  • UPDATED_AT

WhatsAppMessageType

The type of WhatsApp message

Values

  • FREEFORM
  • TEMPLATE