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 bybyType(ContactMethodTypeFilter) — The ContactMethodType to filter results bybyTypes([ContactMethodTypeFilter!]) — An array of ContactMethodTypes to filter results bycontact(String) — A contact to filter results byfirst(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 resultssortBy(SortContactMethodsBy) — The sort keysortDir(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 Draftfirst(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 Messagesfirst(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 keysortDir(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 applyfirst(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 resultssortBy(SortConversationsBy) — The sort keysortDir(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 applyfirst(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 resultssortBy(SortDraftsBy) — The sort keysortDir(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 applyfirst(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 resultssortBy(SortMessagesBy) — The sort keysortDir(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 applyfirst(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 resultssortBy(SortTemplatesBy) — The sort keysortDir(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 createddisabled_at(DateTime) — The date the ContactMethod was disabledexternal_contact_address(String) — The external contact address of the ContactMethodid(ID!) — The unique identifier of the ContactMethodname(String!) — The name of the ContactMethodtype(ContactMethodType!) — The type of the ContactMethodupdated_at(DateTime!) — The date the ContactMethod was last updated
ContactMethodConnection
A connection to a list of items.
Fields
edges([ContactMethodEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.
ContactMethodEdge
An edge in a connection.
Fields
cursor(String!) — A cursor for use in paginationnode(ContactMethod) — The item at the end of the edge
Conversation
Fields
blocked_at(DateTime)contact_method(ContactMethod!) — The ContactMethod that this Conversation is associated withcreated_at(DateTime!)current_participants([User!]!) — The Users that are currently participating in this Conversationcustom_attributes([ConversationCustomAttribute!]) — The custom attributes of the Conversationcustomer(Customer) — The Customer associated with this Conversationexternal_contact_address(ID!)first_message(Message) — The first Message in this Conversationid(ID!)latest_message(Message) — The latest Message in this Conversationlatest_single_recipient_sent_or_scheduled_draft(Draft) — The most recently updated single-recipient Draft that has been sent or scheduled for this Conversationmessaging_subscription(MessagingSubscription) — The MessagingSubscription that this Conversation is associated withname(String) — The name of the Conversationpast_participants([User!]!) — The Users that have previously participated in this Conversationshow_as_unclaimed_for_onboarding(Boolean!)status(ConversationStatus!)status_updated_at(DateTime) — The timestamp when the status of the Conversation was updatedstatus_updated_by_user(User) — The User that last updated the status of the Conversationsummary(String) — The summary of the Conversationtype(ContactMethodType!) — The type of the Conversationupdated_at(DateTime!)web_url(URL!) — The URL to the Conversation inside the web application — 🚧 Deprecated: No longer supportedwhatsapp_status(WhatsappStatus) — WhatsApp status information for the conversation
ConversationBooleanCustomAttribute
Fields
boolean(ConversationBooleanCustomAttributeData!) — The boolean value of the ConversationCustomAttributecreated_at(DateTime!) — The date and time the ConversationCustomAttribute was createdkey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributeupdated_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
edges([ConversationEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.total(Int)
ConversationCustomAttributePage
Fields
ConversationDateCustomAttribute
Fields
created_at(DateTime!) — The date and time the ConversationCustomAttribute was createddate(ConversationDateCustomAttributeData!) — The date value of the ConversationCustomAttributekey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributeupdated_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 paginationnode(Conversation) — The item at the end of the edge
ConversationMoneyCustomAttribute
Fields
created_at(DateTime!) — The date and time the ConversationCustomAttribute was createdkey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributemoney(ConversationMoneyCustomAttributeData!) — The money value of the ConversationCustomAttributeupdated_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 createdkey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributetext(ConversationTextCustomAttributeData!) — The text value of the ConversationCustomAttributeupdated_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 createdkey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributeupdated_at(DateTime!) — The date and time the ConversationCustomAttribute was last updatedurl(ConversationUrlCustomAttributeData!) — The url value of the ConversationCustomAttribute
ConversationUrlCustomAttributeData
Fields
value(HTTPURL) — The value of the ConversationCustomAttributevalue_v2(ConversationCustomAttributePage) — The value of the ConversationCustomAttribute
Draft
A draft from which a Message may be created
Fields
body_html(String!) — An HTML version of the Draftbody_text(String!) — A plaintext version of the Draftbody_text_preview(String!) — A preview of the Draftbody_text_summary(String!) — A summary version of the Messagecc([String!]) — The cc addresses of the Draftcontact_method(ContactMethod) — The ContactMethod that will be used to send this Draftcontents([DraftContent!]!) — The contents of the Draftcreated_at(DateTime!) — The date and time at which the Draft was createdcreator(User!) — The User who created the Draftdeleted_at(DateTime) — The time at which the Draft was deletedid(ID!) — The ID of the Draftin_reply_to_conversation(Conversation) — The Conversation this Draft is in reply toin_reply_to_thread(Thread) — The Thread this Draft is in reply tolocal_message_created_at(DateTime) — The time at which the local message was createdlocal_message_id(ID) — The local ID of the Draftrecipients(DraftRecipientConnection!) — The recipients of the Draftscheduled_at(DateTime) — The time at which the Draft is scheduled to be sentsending_at(DateTime) — The time at which the Draft transitioned to a status of sendingsending_failed_at(DateTime) — The time at which the Draft transitioned to a status of sending_failedsent_at(DateTime) — The time at which the Draft transitioned to a status of sentstatus(DraftStatus!) — The status of the Draftsubject(NonEmptyString) — The subject of the Draftsubmitted_at(DateTime) — The time at which the Draft was submitted to be sent or scheduledteam(Team!)text_direction(TextDirection!) — The text direction of the Drafttype(ContactMethodType!) — The type of ContactMethod that the Draft will be sent withupdated_at(DateTime!) — The date and time at which the Draft was last updatedweb_url(URL!) — The URL to the Draft inside the web application — 🚧 Deprecated: No longer supported
DraftConnection
A connection to a list of items.
Fields
edges([DraftEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.total(Int)
DraftEdge
An edge in a connection.
Fields
DraftFileContent
Fields
file(DraftFileContentData!)id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content to
DraftFileContentData
Fields
asset(Asset) — The Asset of the filedownload_url(URL!) — A link to download the filemime_type(String) — The mime type of the filesource_url(URL) — The source URL of the filetitle(String!) — The title of the fileurl(URL!) — The source URL of the file — 🚧 Deprecated: Usedownload_urlinstead
DraftImageContent
Fields
id(ID!) — The ID of the Contentimage(DraftImageContentData!)in_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content to
DraftImageContentData
Fields
asset(Asset) — The Asset of the imagedisplay_width(PositiveInt) — The display width of the imageexternal_link_url(URL) — An optional external link URL for the imageheight(PositiveInt) — The height of the imagemime_type(String) — The mime type of the imagepreview_url(URL!) — The preview URL of the imagesource_url(URL) — The source URL of the imagetitle(String!) — The title of the imageurl(URL!) — The source URL of the image — 🚧 Deprecated: Usepreview_urlinsteadwidth(PositiveInt) — The width of the image
DraftRecipient
A potential recipient of a draft
Fields
customer(Customer) — An Endear customer associated to this DraftRecipientemail_address(String) — The email address of the DraftRecipientid(ID!) — The ID of the DraftRecipientphone_number(String) — The phone number of the DraftRecipient
DraftRecipientConnection
A connection to a list of items.
Fields
edges([DraftRecipientEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.
DraftRecipientEdge
An edge in a connection.
Fields
cursor(String!) — A cursor for use in paginationnode(DraftRecipient) — The item at the end of the edge
DraftStoryContent
Fields
id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contentstory(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: Useview_urlinsteadpreview_url(URL!) — The thumbnail URL of the storystory(Story!) — The Story of the storytitle(String!) — The title of the storyurl(URL!) — The source URL of the story — 🚧 Deprecated: Uselink_urlinsteadview_url(URL!) — A URL to view the story
DraftTextContent
Fields
id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content totext(DraftTextContentData!)
DraftTextContentData
Fields
html(String!) — The html body of the text contentplain_text(String!) — The plain text of the text content
DraftUnsubscribeContent
Fields
id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content tounsubscribe(DraftUnsubscribeContentData!)
DraftUnsubscribeContentData
Fields
interpolated_text(String) — The interpolated text of the unsubscribe messagelink_text(String) — The linked text of the unsubscribe messagemessage_text(String) — The message text of the unsubscribe message
DraftVideoContent
Fields
id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content tovideo(DraftVideoContentData!)
DraftVideoContentData
Fields
asset(Asset) — The Asset of the videodisplay_width(PositiveInt) — The display width of the videoheight(PositiveInt) — The height of the videomime_type(String) — The mime type of the videopreview_url(URL) — The thumbnail URL of the videosource_url(URL) — The source URL of the videotitle(String!) — The title of the videourl(URL!) — The source URL of the video — 🚧 Deprecated: Usewatch_urlinsteadwatch_url(URL!) — A link to view the videowidth(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 replybody_html(String!) — An HTML version of the Messagebody_markdown(String!) — A markdown version of the Messagebody_text(String!) — An SMS-text version of the Messagebody_text_preview(String!) — A preview of the Messagecampaign(Campaign) — If the message was created by a Campaign, the Campaigncampaign_draft(CampaignDraft) — The Campaign Draft that originated this message, if message is part of a Campaigncontact_method(ContactMethod!) — The ContactMethod used to send or receive the Messageconversation(Conversation!) — The Conversation the Message belongs tocreated_at(DateTime!) — The date the Message was createddelivered_at(DateTime) — The date the Message was delivereddirection(MessageDirection!) — Whether the Message was sent (outbound) or received (inbound)draft(Draft) — The Draft that was used to create the Messageexpiration_reason(MessageExpirationReason) — The reason the Message expiredexpired_at(DateTime) — The date the Message expiredexternal_contact_address(ID!) — The email address or phone number of the external contactfail_reason(MessageFailReason) — The reason the Message failed to sendfailed_at(DateTime) — The date the Message failed to sendfirst_clicked_at(DateTime) — The date when the Message was first clickedfirst_inbound_reply(Message) — The first inbound reply to this Messagefirst_opened_at(DateTime) — The date when the Message was first opened or readfirst_outbound_reply(Message) — The first outbound reply to this Messagefirst_reply(Message) — The first reply to this Messageid(ID!) — The unique identifier of the Messagein_reply_to(Message) — The Message this Message is in reply tois_opt_out_message(Boolean!) — Whether the Message is an opt-out messageis_reply(Boolean!) — Whether the Message is a replylast_clicked_at(DateTime) — The date when the Message was last clickedlast_inbound_reply(Message) — The last inbound reply to this Messagelast_opened_at(DateTime) — The date when the Message was last opened or readlast_opened_at_for_reporting(DateTime) — The date when the Message was last opened or readlast_outbound_reply(Message) — The last outbound reply to this Messagelast_reply(Message) — The last reply to this Messagelatest_reply(Message) — The latest reply to the Message — 🚧 Deprecated: Use last_reply insteadmessaging_application(MessagingApplication) — The MessagingApplication that created the Messagepermanently_redacted_at(DateTime) — The date the Message was permanently redactedprovider_fail_reason(String) — The reason the Message failed to send from the providerredacted_at(DateTime) — The date the Message was redactedsender_messaging_application(MessagingApplication) — The MessagingApplication that sent the Messagesent_as(User) — The User that sent the Message was sent assent_at(DateTime) — The date the Message was sentsent_from_team(Team) — The Team that sent the Message was sent fromsent_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 Messagesubject(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 insteadtemplate(Template) — The Template that was used to create the Messagethread(Thread) — The Thread this Message is inttl_expires_at(DateTime) — The date when the ability to reply to the message expirestype(ContactMethodType!) — The type of the Messageupdated_at(DateTime!) — The date the Message was last updatedutm_code(String) — The UTM code of the Messagevia(MessageSentVia!) — The method by which the Message was sentweb_url(URL!) — The URL to the Message inside the web application — 🚧 Deprecated: No longer supportedwhatsapp_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 createddays_to_convert(Int!) — The number of days between the Message being sent and the Order being createddeleted_at(DateTime) — The date the MessageAttribution was deletedid(ID!) — The unique identifier of the MessageAttributionis_clicked_before_conversion(Boolean!) — Whether the Message was clicked before the Order was createdis_opened_before_conversion(Boolean!) — Whether the Message was opened before the Order was createdis_replied_to_before_conversion(Boolean!) — Whether the Message was replied to before the Order was createdmanually_excluded_at(DateTime) — The date the OrderAttribution was manually excludedmessage(Message!) — The Message associated to the MessageAttributionupdated_at(DateTime!) — The date the MessageAttribution was last updated
MessageConnection
A connection to a list of items.
Fields
edges([MessageEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.total(Int)
MessageEdge
An edge in a connection.
Fields
MessagingApplication
The MessagingApplication for the Message
Fields
external_message_id(ID) — The external ID of the Messageintegration(Integration) — The Integration for the MessagingApplicationtype(MessagingApplicationType!) — The type of the MessagingApplication
Template
Fields
body_html(String) — An HTML version of the Templatebody_text(String!) — A plaintext version of the Templatebody_text_preview(String)contents([DraftContent!]!) — The contents of the Templatecreated_at(DateTime!)creator(User!)deleted_at(DateTime)id(ID!)subject(NonEmptyString)text_direction(TextDirection!) — The text direction of the Templatetitle(NonEmptyString)type(ContactMethodType!)updated_at(DateTime!)web_url(URL!) — The URL to the Template inside the web application — 🚧 Deprecated: No longer supported
TemplateConnection
A connection to a list of items.
Fields
edges([TemplateEdge]) — A list of edges.pageInfo(PageInfo!) — Information to aid in pagination.total(Int)
TemplateEdge
An edge in a connection.
Fields
Thread
Fields
id(ID!)
WhatsappStatus
WhatsApp status information for a conversation
Fields
consent_expiration_notified_at(DateTime) — When the consent expiration notification was sentopt_in_expires_at(DateTime) — When the WhatsApp session TTL expiresopt_in_initiated_at(DateTime) — When the opt-in process was initiatedopt_in_prompt_message(Message) — The prompt message that was sentopt_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 createdkey(ID!) — The key of the ConversationCustomAttributelabel(String!) — The label of the ConversationCustomAttributeupdated_at(DateTime!) — The date and time the ConversationCustomAttribute was last updated
Implemented by
ConversationBooleanCustomAttributeConversationDateCustomAttributeConversationMoneyCustomAttributeConversationTextCustomAttributeConversationUrlCustomAttribute
DraftContentInterface
Fields
id(ID!) — The ID of the Contentin_signature(Boolean!) — Whether the Content is in the signatureinitial(Boolean!) — Whether the Content is the initial Contenttemplate_id(ID) — The ID of Template to attribute the content to
Implemented by
DraftAppointmentBookingPageContentDraftBrandingContentDraftFileContentDraftImageContentDraftLocationContentDraftProductContentDraftProductContentDataDraftProductsContentDraftStoryContentDraftTextContentDraftUnsubscribeContentDraftVideoContent
Unions
ConversationCustomAttribute
Possible types
ConversationBooleanCustomAttributeConversationDateCustomAttributeConversationMoneyCustomAttributeConversationTextCustomAttributeConversationUrlCustomAttribute
DraftContent
Possible types
DraftAppointmentBookingPageContentDraftBrandingContentDraftFileContentDraftImageContentDraftLocationContentDraftProductsContentDraftStoryContentDraftTextContentDraftUnsubscribeContentDraftVideoContent
Enums
ContactMethodStatusFilter
The status of the ContactMethod to filter results by
Values
ACTIVEALLDISABLED
ContactMethodType
Values
EMAILLIVE_CHATSMSWHATSAPP
ContactMethodTypeFilter
The type of the ContactMethod to filter results by
Values
ALLEMAILINBOUNDLIVE_CHATOUTBOUNDSMSWHATSAPP
ConversationStatus
Values
BLOCKEDCLOSEDINACTIVEOPEN
DraftStatus
Values
CREATEDSCHEDULEDSENDINGSENDING_FAILEDSENT
LimitSmsDraftsBy
Values
CHARACTERSSEGMENTS
MessageDirection
Values
INBOUNDOUTBOUND
MessageExpirationReason
The reason the message was expired
Values
NO_OPT_IN_AFTER_TIMEOUTOPT_IN_PROMPT_MESSAGE_CHANGED
MessageFailReason
The reason the message failed
Values
BOUNCECONTACT_METHOD_DISABLEDCONTENT_SIZE_EXCEEDEDFRAUD_VERIFICATION_INCOMPLETEGEO_PERMISSIONHARD_BOUNCEINVALID_MESSAGE_BODYINVALID_RECIPIENT_CONTACTINVALID_SENDER_CONTACTMISSING_OR_DELETED_ASSETSMMS_NOT_SUPPORTEDPREVIOUSLY_UNSUBSCRIBEDQUIET_HOURSRESTRICTED_DESIGNATIONSMS_NOT_SUPPORTEDSPAM_COMPLAINTUNKNOWN_ERRORUNSUPPORTED_MEDIA_TYPEWHATSAPP_BUSINESS_MANAGER_ERRORWHATSAPP_INVALID_MESSAGE_RECIPIENTWHATSAPP_MARKETING_REJECTIONWHATSAPP_PROMPT_RECENTLY_SENT
MessageSentVia
Values
EMAILLIVE_CHATSMSWHATSAPP
MessageStatus
Values
AWAITING_OPT_INCREATEDDELIVEREDEXPIREDFAILEDSENT
MessagingApplicationType
Values
APIGORGIASKUSTOMERMOBILESHOPIFY_POSWEB
SortContactMethodsBy
The available keys to sort ContactMethods
Values
CREATED_ATNAMEUPDATED_AT
SortConversationsBy
The available keys to sort Conversations
Values
CREATED_ATLAST_MESSAGE_ATSTATUSUPDATED_AT
SortDraftsBy
The available keys to sort Drafts
Values
CREATED_ATSCHEDULED_ATSTATUSUPDATED_AT
SortMessagesBy
The available keys to sort Messages
Values
CREATED_ATUPDATED_AT
SortTemplatesBy
The available keys to sort Templates
Values
CREATED_ATCREATORUPDATED_AT
WhatsAppMessageType
The type of WhatsApp message
Values
FREEFORMTEMPLATE
