Skip to main content

Inputs

AccountPreferenceUpsertInput​

Autogenerated input type of AccountPreferenceUpsert

input AccountPreferenceUpsertInput {
  key: String!
  value: JSON
  clientMutationId: String
}

ActionInput​

No description

input ActionInput {
  id: ID
  type: RuleActionType!
  value: String
  toAgent: String
  replyTemplate: RuleReplyTemplateInput
}

AgentFilter​

No description

input AgentFilter {
  state: AgentState
  channelId: ID
}

AgentNotificationPreferenceBulkDeleteInput​

Autogenerated input type of AgentNotificationPreferenceBulkDelete

input AgentNotificationPreferenceBulkDeleteInput {
  ids: [ID!]!
  clientMutationId: String
}

AgentNotificationPreferenceBulkUpsertInput​

Autogenerated input type of AgentNotificationPreferenceBulkUpsert

input AgentNotificationPreferenceBulkUpsertInput {
  notificationPreferences: [AgentNotificationPreferenceInput!]!
  clientMutationId: String
}

AgentNotificationPreferenceInput​

No description

input AgentNotificationPreferenceInput {
  id: ID
  key: String!
  namespace: AgentNotificationPreferenceNotificationNamespaceType
  value: [AgentNotificationPreferenceNotificationType!]
}

AgentOrder​

No description

input AgentOrder {
  field: AgentOrderField
  direction: OrderDirection
}

AgentPreferenceDeleteInput​

Autogenerated input type of AgentPreferenceDelete

input AgentPreferenceDeleteInput {
  key: String!
  clientMutationId: String
}

AgentPreferenceUpsertInput​

Autogenerated input type of AgentPreferenceUpsert

input AgentPreferenceUpsertInput {
  key: String!
  namespace: String
  value: JSON!
  clientMutationId: String
}

AgentPreferencesFilterInput​

No description

input AgentPreferencesFilterInput {
  agentId: ID
  namespace: String
  keys: [String!]
}

AgentResetLoginAttemptsInput​

Autogenerated input type of AgentResetLoginAttempts

input AgentResetLoginAttemptsInput {
  agentId: ID
  clientMutationId: String
}

AgentResetPasswordInput​

Autogenerated input type of AgentResetPassword

input AgentResetPasswordInput {
  token: String!
  recaptchaToken: String!
  password: String!
  passwordConfirm: String!
  authCode: String
  clientMutationId: String
}

AgentSendAdminEmailNotificationInput​

Autogenerated input type of AgentSendAdminEmailNotification

input AgentSendAdminEmailNotificationInput {
  notificationType: AdminEmailNotification!
  clientMutationId: String
}

ArticleFilter​

No description

input ArticleFilter {
  author: ID
  category: ID
  featured: Boolean
  ids: [ID!]
  keywords: String
  knowledgeBase: ID
  state: [PublishState!]
  tag: String
}

ArticleOrder​

No description

input ArticleOrder {
  field: ArticleOrderField
  direction: OrderDirection
}

AssignedFilter​

Filters conversations by their assigned agent or team, or those that explicitly are not assigned.

For example, to find a conversation assigned to a specific agent and any team:

filter: { assigned: { agent: "ag_1234567" }`

To find a conversation assigned to a specific agent and no team:

filter: { assigned: { agent: "ag_1234567", no_team: true }
input AssignedFilter {
  agent: ID
  noAgent: Boolean
  team: ID
  noTeam: Boolean
  any: Boolean
}

AssignmentInput​

No description

input AssignmentInput {
  agentId: ID
  teamId: ID
}

AsyncRpcInput​

Autogenerated input type of AsyncRpc

input AsyncRpcInput {
  service: String!
  method: String!
  params: JSON
  clientMutationId: String
}

AttachmentsFilterInput​

No description

input AttachmentsFilterInput {
  conversationId: ID!
  conversationType: AttachmentsConversationTypeEnum!
}

CancelDowngradeInput​

Autogenerated input type of CancelDowngrade

input CancelDowngradeInput {
  clientMutationId: String
}

CannedReplyFilter​

No description

input CannedReplyFilter {
  ids: [ID!]
  keywords: String
  categoryIds: [ID!]
}

CannedReplyOrder​

No description

input CannedReplyOrder {
  field: CannedReplyOrderField
  direction: OrderDirection
}

CardSetupIntentCreateInput​

Autogenerated input type of CardSetupIntentCreate

input CardSetupIntentCreateInput {
  clientMutationId: String
}

CardSetupIntentSucceedInput​

Autogenerated input type of CardSetupIntentSucceed

input CardSetupIntentSucceedInput {
  setupIntentId: ID!
  clientMutationId: String
}

CategoryOrder​

No description

input CategoryOrder {
  field: CategoryOrderField
  direction: OrderDirection
}

ChannelDeleteInput​

Autogenerated input type of ChannelDelete

input ChannelDeleteInput {
  channelId: ID!
  clientMutationId: String
}

ChannelFilter​

No description

input ChannelFilter {
  state: ChannelState
  scope: ChannelScope
}

ChannelOrder​

No description

input ChannelOrder {
  field: ChannelOrderField
  direction: OrderDirection
}

CheckAccessByMatrixIdsInput​

Autogenerated input type of CheckAccessByMatrixIds

input CheckAccessByMatrixIdsInput {
  matrixRoomIds: [ID!]!
  clientMutationId: String
}

ClickCreateInput​

Autogenerated input type of ClickCreate

input ClickCreateInput {
  referralCode: String!
  clientMutationId: String
}

CompanyAddContactsInput​

Autogenerated input type of CompanyAddContacts

input CompanyAddContactsInput {
  companyId: ID!
  contactIds: [ID!]!
  clientMutationId: String
}

CompanyCreateInput​

Autogenerated input type of CompanyCreate

input CompanyCreateInput {
  customFields: [CustomFieldInput!]
  clientMutationId: String
}

CompanyDeleteInput​

Autogenerated input type of CompanyDelete

input CompanyDeleteInput {
  companyId: ID!
  clientMutationId: String
}

CompanyFilter​

No description

input CompanyFilter {
  search: String
}

CompanyMergeInput​

Autogenerated input type of CompanyMerge

input CompanyMergeInput {
  companyId: ID!
  targetId: ID!
  keepFieldIds: [ID!]
  clientMutationId: String
}

CompanyOrder​

No description

input CompanyOrder {
  field: CompanyOrderField
  direction: OrderDirection
}

CompanyRemoveContactsInput​

Autogenerated input type of CompanyRemoveContacts

input CompanyRemoveContactsInput {
  companyId: ID!
  contactIds: [ID!]!
  clientMutationId: String
}

ConditionInput​

Input type for a folder condition, which defines the logic for filtering conversations.

input ConditionInput {
  id: ID
  param: ConditionParam!
  operator: ConditionOperator!
  value: String
  sourceId: ID
}

ConditionOrder​

No description

input ConditionOrder {
  field: ConditionOrderField
  direction: OrderDirection
}

ContactCreateInput​

Autogenerated input type of ContactCreate

input ContactCreateInput {
  contactType: ContactType!
  customFields: [CustomFieldInput!]
  companyId: ID
  skipCompanyCreation: Boolean
  clientMutationId: String
}

ContactCustomFieldsFilter​

No description

input ContactCustomFieldsFilter {
  key: String!
  values: [String!]!
}

ContactDeleteInput​

Autogenerated input type of ContactDelete

input ContactDeleteInput {
  contactId: ID!
  clientMutationId: String
}

ContactFilter​

No description

input ContactFilter {
  search: String
  email: String
  customFields: [ContactCustomFieldsFilter!]
}

ContactMergeInput​

Autogenerated input type of ContactMerge

input ContactMergeInput {
  sourceId: ID!
  targetId: ID!
  keepFieldIds: [ID!]
  clientMutationId: String
}

ContactOrder​

No description

input ContactOrder {
  field: ContactOrderField
  direction: OrderDirection
}

ContactResyncInput​

Autogenerated input type of ContactResync

input ContactResyncInput {
  contactId: ID!
  integrationId: ID!
  clientMutationId: String
}

ContactUpdateInput​

Autogenerated input type of ContactUpdate

input ContactUpdateInput {
  contactId: ID!
  contactType: ContactType!
  clientMutationId: String
}

conversationAddNoteInput​

Autogenerated input type of conversationAddNote

input conversationAddNoteInput {
  snoozeUntil: DateTime
  agentId: ID
  teamId: ID
  conversationId: ID!
  body: String
  draftId: String
  attachments: [EmailAttachmentInput!]
  state: ConversationState
  skipNotifications: Boolean
  authorId: ID
  createdAt: DateTime
  updatedAt: DateTime
  authorReassign: Boolean
  clientMutationId: String
}

ConversationAssignInput​

Autogenerated input type of ConversationAssign

input ConversationAssignInput {
  agentId: ID
  teamId: ID
  conversationId: ID!
  skipNotifications: Boolean
  clientMutationId: String
}

ConversationBulkDeleteInput​

Autogenerated input type of ConversationBulkDelete

input ConversationBulkDeleteInput {
  conversationIds: [ID!]!
  deleteMode: DeleteMode
  clientMutationId: String
}

ConversationChangeChannelInput​

Autogenerated input type of ConversationChangeChannel

input ConversationChangeChannelInput {
  conversationId: ID!
  channelId: ID!
  skipNotifications: Boolean
  clientMutationId: String
}

ConversationChangeContactInput​

Autogenerated input type of ConversationChangeContact

input ConversationChangeContactInput {
  conversationId: ID!
  contactId: ID!
  clientMutationId: String
}

ConversationCloseInput​

Autogenerated input type of ConversationClose

input ConversationCloseInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationCountFilter​

No description

input ConversationCountFilter {
  states: [ConversationState!]
}

ConversationCreateEmailInput​

Autogenerated input type of ConversationCreateEmail

input ConversationCreateEmailInput {
  snoozeUntil: DateTime
  assigned: AssignmentInput
  channelId: ID!
  message: EmailMessageInput!
  state: ConversationState
  cannedReplyId: ID
  draftId: String
  tagIds: [ID!]
  skipNotifications: Boolean
  createdAt: DateTime
  clientMutationId: String
}

ConversationDeleteInput​

Autogenerated input type of ConversationDelete

input ConversationDeleteInput {
  conversationIds: [ID!]!
  deleteMode: DeleteMode
  clientMutationId: String
}

conversationDeleteNoteInput​

Autogenerated input type of conversationDeleteNote

input conversationDeleteNoteInput {
  snoozeUntil: DateTime
  messageId: ID!
  skipNotifications: Boolean
  clientMutationId: String
}

conversationEditNoteInput​

Autogenerated input type of conversationEditNote

input conversationEditNoteInput {
  snoozeUntil: DateTime
  messageId: ID!
  body: String
  attachments: [EmailAttachmentInput!]
  skipNotifications: Boolean
  clientMutationId: String
}

ConversationFilter​

No description

input ConversationFilter {
  assigned: AssignedFilter
  channelId: ID
  contactId: ID
  contactEmail: String
  deleted: Boolean
  draftAuthor: ID
  draftType: DraftType
  folderId: ID
  keywords: String
  mentionedAgent: ID
  rating: RatingEnum
  starred: Boolean
  state: ConversationState
  states: [ConversationState!]
  tags: [ID!]
  tagNames: [String!]
  type: [ConversationType!]
  beforeCreatedAt: DateTime
  afterCreatedAt: DateTime
  beforeUpdatedAt: DateTime
  afterUpdatedAt: DateTime
  customFields: [CustomFieldSearchInput!]
}

ConversationFollowInput​

Autogenerated input type of ConversationFollow

input ConversationFollowInput {
  conversationId: ID!
  followerIds: [ID!]!
  clientMutationId: String
}

ConversationForwardInput​

Autogenerated input type of ConversationForward

input ConversationForwardInput {
  snoozeUntil: DateTime
  agentId: ID
  teamId: ID
  conversationId: ID!
  body: String
  to: Email!
  cc: [Email!]
  bcc: [Email!]
  subject: String
  attachments: [EmailAttachmentInput!]
  cannedReplyId: ID
  draftId: String
  state: ConversationState
  channelId: ID
  skipNotifications: Boolean
  clientMutationId: String
}

ConversationForwardV2Input​

Autogenerated input type of ConversationForwardV2

input ConversationForwardV2Input {
  snoozeUntil: DateTime
  agentId: ID
  teamId: ID
  conversationId: ID!
  body: String
  to: [Email!]!
  cc: [Email!]
  bcc: [Email!]
  subject: String
  attachments: [EmailAttachmentInput!]
  cannedReplyId: ID
  draftId: String
  state: ConversationState
  tagIdsToAdd: [ID!]
  tagIdsToRemove: [ID!]
  removeAllTags: Boolean
  channelId: ID
  skipNotifications: Boolean
  clientMutationId: String
}

conversationLinkResourceInput​

Autogenerated input type of conversationLinkResource

input conversationLinkResourceInput {
  conversationId: ID!
  externalId: String!
  provider: IntegrationProvider!
  removed: Boolean
  title: String!
  url: String!
  clientMutationId: String
}

ConversationLogInput​

Autogenerated input type of ConversationLog

input ConversationLogInput {
  snoozeUntil: DateTime
  contactId: ID
  skipNotifications: Boolean
  assigned: AssignmentInput
  channelId: ID!
  message: NoteMessageInput!
  state: ConversationState
  cannedReplyId: ID
  draftId: String
  createdAt: DateTime
  authorId: ID
  clientMutationId: String
}

ConversationMergeInput​

Autogenerated input type of ConversationMerge

input ConversationMergeInput {
  sourceId: ID!
  targetId: ID!
  clientMutationId: String
}

ConversationMoveMessageInput​

Autogenerated input type of ConversationMoveMessage

input ConversationMoveMessageInput {
  messageId: ID!
  clientMutationId: String
}

ConversationOpenInput​

Autogenerated input type of ConversationOpen

input ConversationOpenInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationOrder​

No description

input ConversationOrder {
  field: ConversationOrderField
  direction: OrderDirection
}

ConversationReplyInput​

Autogenerated input type of ConversationReply

input ConversationReplyInput {
  snoozeUntil: DateTime
  agentId: ID
  teamId: ID
  conversationId: ID!
  body: String
  to: Email!
  cc: [Email!]
  bcc: [Email!]
  subject: String
  attachments: [EmailAttachmentInput!]
  draftId: String
  cannedReplyId: ID
  state: ConversationState
  skipNotifications: Boolean
  createdAt: DateTime
  updatedAt: DateTime
  tagIdsToAdd: [ID!]
  tagIdsToRemove: [ID!]
  removeAllTags: Boolean
  authorId: ID
  contactId: ID
  channelId: ID
  clientMutationId: String
}

conversationRestoreInput​

Autogenerated input type of conversationRestore

input conversationRestoreInput {
  conversationIds: [ID!]!
  newState: ConversationRestoreState!
  clientMutationId: String
}

ConversationSnoozeInput​

Autogenerated input type of ConversationSnooze

input ConversationSnoozeInput {
  conversationId: ID!
  until: DateTime
  clientMutationId: String
}

ConversationSpamInput​

Autogenerated input type of ConversationSpam

input ConversationSpamInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationStarInput​

Autogenerated input type of ConversationStar

input ConversationStarInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationSubjectInput​

Autogenerated input type of ConversationSubject

input ConversationSubjectInput {
  conversationId: ID!
  subject: String!
  clientMutationId: String
}

ConversationTagInput​

Autogenerated input type of ConversationTag

input ConversationTagInput {
  conversationId: ID!
  tagIds: [ID!]!
  clientMutationId: String
}

conversationToggleNoteReactionInput​

Autogenerated input type of conversationToggleNoteReaction

input conversationToggleNoteReactionInput {
  snoozeUntil: DateTime
  messageId: ID!
  reaction: String!
  skipNotifications: Boolean
  clientMutationId: String
}

ConversationTrashInput​

Autogenerated input type of ConversationTrash

input ConversationTrashInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationUnassignInput​

Autogenerated input type of ConversationUnassign

input ConversationUnassignInput {
  conversationId: ID!
  agent: Boolean
  team: Boolean
  skipNotifications: Boolean
  clientMutationId: String
}

conversationUndoSendInput​

Autogenerated input type of conversationUndoSend

input conversationUndoSendInput {
  conversationId: ID!
  changesetId: ID!
  clientMutationId: String
}

ConversationUnfollowInput​

Autogenerated input type of ConversationUnfollow

input ConversationUnfollowInput {
  conversationId: ID!
  followerIds: [ID!]!
  clientMutationId: String
}

ConversationUnreadInput​

Autogenerated input type of ConversationUnread

input ConversationUnreadInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationUnstarInput​

Autogenerated input type of ConversationUnstar

input ConversationUnstarInput {
  conversationId: ID!
  clientMutationId: String
}

ConversationUntagInput​

Autogenerated input type of ConversationUntag

input ConversationUntagInput {
  conversationId: ID!
  tagIds: [ID!]!
  clientMutationId: String
}

CrmEnduserUpsertInput​

Autogenerated input type of CrmEnduserUpsert

input CrmEnduserUpsertInput {
  contactId: ID!
  firstName: String
  lastName: String
  clientMutationId: String
}

CustomFieldCategoryCreateInput​

Autogenerated input type of CustomFieldCategoryCreate

input CustomFieldCategoryCreateInput {
  type: CustomFieldCategoryType!
  key: String!
  name: String!
  clientMutationId: String
}

CustomFieldCategoryDeleteInput​

Autogenerated input type of CustomFieldCategoryDelete

input CustomFieldCategoryDeleteInput {
  categoryId: ID!
  newCategoryId: ID
  clientMutationId: String
}

CustomFieldCategoryFilter​

No description

input CustomFieldCategoryFilter {
  categoryType: CustomFieldCategoryType
}

CustomFieldCategoryUpdateInput​

Autogenerated input type of CustomFieldCategoryUpdate

input CustomFieldCategoryUpdateInput {
  categoryId: ID!
  name: String
  clientMutationId: String
}

CustomFieldCreateInput​

Autogenerated input type of CustomFieldCreate

input CustomFieldCreateInput {
  key: String!
  name: String!
  icon: CustomFieldIcon
  description: String
  type: CustomFieldType!
  placeholder: String
  options: [CustomFieldOptionInput!]
  isArray: Boolean!
  required: Boolean
  categoryId: ID!
  clientMutationId: String
}

CustomFieldDeleteInput​

Autogenerated input type of CustomFieldDelete

input CustomFieldDeleteInput {
  customFieldId: ID!
  deleteMode: DeleteMode
  clientMutationId: String
}

CustomFieldFilter​

No description

input CustomFieldFilter {
  categoryIds: [ID!]
  deleted: Boolean
}

CustomFieldInput​

No description

input CustomFieldInput {
  customFieldIdOrKey: String!
  value: JSON
  position: Int
}

CustomFieldLinkInput​

No description

input CustomFieldLinkInput {
  key: String!
  name: String!
  icon: CustomFieldIcon
  description: String
  type: CustomFieldType!
  placeholder: String
  options: [CustomFieldOptionInput!]
  isArray: Boolean!
  required: Boolean
  scope: CustomFieldLinkScope!
}

CustomFieldListInput​

No description

input CustomFieldListInput {
  customFieldIdOrKey: String!
  value: JSON
  position: Int
  mode: customFieldValueUpdateMode
  remove: Boolean
}

CustomFieldOptionDeleteInput​

Autogenerated input type of CustomFieldOptionDelete

input CustomFieldOptionDeleteInput {
  customFieldOptionId: ID!
  clientMutationId: String
}

CustomFieldOptionInput​

No description

input CustomFieldOptionInput {
  label: String!
  value: String!
}

CustomFieldRemoveInput​

Autogenerated input type of CustomFieldRemove

input CustomFieldRemoveInput {
  customFieldId: ID!
  itemId: ID!
  clientMutationId: String
}

customFieldRestoreInput​

Autogenerated input type of customFieldRestore

input customFieldRestoreInput {
  customFieldId: ID!
  clientMutationId: String
}

CustomFieldSearchInput​

No description

input CustomFieldSearchInput {
  customFieldId: ID!
  values: [String!]
}

CustomFieldUpdateInput​

Autogenerated input type of CustomFieldUpdate

input CustomFieldUpdateInput {
  customFieldId: ID!
  categoryId: ID!
  name: String!
  icon: CustomFieldIcon
  description: String
  type: CustomFieldType!
  placeholder: String
  options: [CustomFieldOptionInput!]
  handleType: String
  required: Boolean
  clientMutationId: String
}

CustomFieldValuesBulkUpdateInput​

Autogenerated input type of CustomFieldValuesBulkUpdate

input CustomFieldValuesBulkUpdateInput {
  items: [SubjectWithCustomFieldsInput!]!
  sync: Boolean
  clientMutationId: String
}

CustomFieldValuesFilter​

No description

input CustomFieldValuesFilter {
  categoryIds: [ID!]
  keys: [String!]
  customFieldIds: [ID!]
  deleted: Boolean
}

CustomFieldValuesUpdateInput​

Autogenerated input type of CustomFieldValuesUpdate

input CustomFieldValuesUpdateInput {
  customFieldList: [CustomFieldListInput!]
  subjectId: ID!
  clientMutationId: String
}

CustomerRatingSettingDeleteInput​

Autogenerated input type of CustomerRatingSettingDelete

input CustomerRatingSettingDeleteInput {
  settingId: ID
  clientMutationId: String
}

CustomerRatingSettingUpsertInput​

Autogenerated input type of CustomerRatingSettingUpsert

input CustomerRatingSettingUpsertInput {
  settingId: ID
  locale: String!
  mailboxIds: [String!]
  name: String!
  translations: JSON
  clientMutationId: String
}

DeleteRoomInput​

Autogenerated input type of DeleteRoom

input DeleteRoomInput {
  conversationId: ID!
  clientMutationId: String
}

DisconnectMutationInput​

Autogenerated input type of DisconnectMutation

input DisconnectMutationInput {
  channelId: ID!
  clientMutationId: String
}

DraftDeleteInput​

Autogenerated input type of DraftDelete

input DraftDeleteInput {
  draftId: String!
  clientMutationId: String
}

DraftFilter​

No description

input DraftFilter {
  id: ID
  draftId: String
  conversationId: ID
  draftType: DraftType
}

DraftOrder​

No description

input DraftOrder {
  field: DraftOrderField
  direction: OrderDirection
}

DraftSaveInput​

Autogenerated input type of DraftSave

input DraftSaveInput {
  draftId: ID!
  conversationId: ID!
  contextId: ID
  version: Int!
  payload: String!
  draftType: String!
  synchronous: Boolean
  clientMutationId: String
}

DraftUpsertInput​

Autogenerated input type of DraftUpsert

input DraftUpsertInput {
  draftId: String!
  conversationId: ID!
  contextId: ID
  version: Int!
  payload: JSON!
  metadata: JSON
  draftType: DraftType!
  clientMutationId: String
}

EmailAttachmentInput​

No description

input EmailAttachmentInput {
  key: String!
  fileName: String!
  fileSize: String!
  contentType: String!
}

EmailChannelCreateInput​

Autogenerated input type of EmailChannelCreate

input EmailChannelCreateInput {
  type: ChannelType!
  email: String
  name: String!
  senderName: String
  color: String!
  permittedAgentIds: [ID!]
  permittedTeamIds: [ID!]
  incomingEmailServer: ImapServerInput
  outgoingEmailServer: SmtpServerInput
  signature: String
  position: Int
  emailTemplates: [EmailTemplateInput!]
  aiDraftsChannelIds: [ID!]
  aiDraftsKnowledgeBaseIds: [ID!]
  autoBccAddress: String
  useAgentName: Boolean
  threadingType: ThreadingType
  customFields: [CustomFieldLinkInput!]
  clientMutationId: String
}

EmailChannelUpdateInput​

Autogenerated input type of EmailChannelUpdate

input EmailChannelUpdateInput {
  type: ChannelType!
  email: String
  name: String!
  senderName: String
  color: String!
  permittedAgentIds: [ID!]
  permittedTeamIds: [ID!]
  incomingEmailServer: ImapServerInput
  outgoingEmailServer: SmtpServerInput
  signature: String
  position: Int
  emailTemplates: [EmailTemplateInput!]
  aiDraftsChannelIds: [ID!]
  aiDraftsKnowledgeBaseIds: [ID!]
  autoBccAddress: String
  useAgentName: Boolean
  threadingType: ThreadingType
  customFields: [CustomFieldLinkInput!]
  channelId: ID!
  clientMutationId: String
}

EmailMarketingSubscriptionCreateInput​

Autogenerated input type of EmailMarketingSubscriptionCreate

input EmailMarketingSubscriptionCreateInput {
  integrationId: ID!
  listId: String!
  contactId: ID!
  clientMutationId: String
}

EmailMarketingSubscriptionDeleteInput​

Autogenerated input type of EmailMarketingSubscriptionDelete

input EmailMarketingSubscriptionDeleteInput {
  integrationId: ID!
  listId: String!
  contactId: ID!
  clientMutationId: String
}

EmailMessageInput​

No description

input EmailMessageInput {
  subject: String!
  body: String!
  createdAt: DateTime
  updatedAt: DateTime
  to: [EmailRecipientInput!]!
  cc: [EmailRecipientInput!]
  bcc: [EmailRecipientInput!]
  attachments: [EmailAttachmentInput!]
  authorId: ID
}

EmailRecipientInput​

No description

input EmailRecipientInput {
  name: String!
  email: String!
}

EmailTemplateInput​

Input object for email template details.

input EmailTemplateInput {
  body: String!
  state: EmailTemplateState!
  subject: String!
  trigger: EmailTemplateTrigger
}

EventGroupsFilterInput​

No description

input EventGroupsFilterInput {
  conversationId: ID
  conversationIds: [ID!]
  changesetId: String
}

EventsFilterInput​

No description

input EventsFilterInput {
  conversationId: ID!
  eventGroupId: ID
  changesetId: String
  eventType: [EventType!]
}

EventsShopifyCreateInput​

Autogenerated input type of EventsShopifyCreate

input EventsShopifyCreateInput {
  agentId: ID
  conversationId: ID!
  changeType: ShopifyChangeType!
  externalId: String!
  meta: JSON
  shopDomain: String!
  clientMutationId: String
}

ExcludedDomainCreateInput​

Autogenerated input type of ExcludedDomainCreate

input ExcludedDomainCreateInput {
  domain: String!
  clientMutationId: String
}

ExcludedDomainDeleteInput​

Autogenerated input type of ExcludedDomainDelete

input ExcludedDomainDeleteInput {
  excludedDomainId: ID!
  clientMutationId: String
}

ExcludedDomainUpdateInput​

Autogenerated input type of ExcludedDomainUpdate

input ExcludedDomainUpdateInput {
  excludedDomainId: ID!
  domain: String!
  clientMutationId: String
}

ExportFilter​

No description

input ExportFilter {
  ids: [ID!]
}

ExportOrder​

No description

input ExportOrder {
  field: ExportOrderField
  direction: OrderDirection
}

FeatureTemplateRuleScheduleSettingsInput​

Input type for the schedule settings configuration for a rule.

input FeatureTemplateRuleScheduleSettingsInput {
  day: Int
  dayOfWeek: String
  days: Int
  seconds: Int
  time: String
}

FolderCreateInput​

Autogenerated input type of FolderCreate

input FolderCreateInput {
  name: String!
  description: String
  matchType: FolderMatchTypes!
  state: FolderState!
  position: Int
  displayCountWhenInactive: Boolean
  hideIfZeroConversations: Boolean
  permittedAgentIds: [ID!]
  permittedTeamIds: [ID!]
  channelIds: [ID!]
  conditions: [ConditionInput!]
  clientMutationId: String
}

FolderDeleteInput​

Autogenerated input type of FolderDelete

input FolderDeleteInput {
  folderId: ID!
  clientMutationId: String
}

FolderFilter​

No description

input FolderFilter {
  ids: [ID!]
  state: FolderState
  channelIds: [ID!]
  type: FolderType
  scope: FolderScope
}

FolderOrder​

No description

input FolderOrder {
  field: FolderOrderField
  direction: OrderDirection
}

FolderUpdateInput​

Autogenerated input type of FolderUpdate

input FolderUpdateInput {
  folderId: ID!
  name: String!
  description: String
  matchType: FolderMatchTypes!
  state: FolderState!
  position: Int
  displayCountWhenInactive: Boolean
  hideIfZeroConversations: Boolean
  permittedAgentIds: [ID!]
  permittedTeamIds: [ID!]
  channelIds: [ID!]
  conditions: [ConditionInput!]
  clientMutationId: String
}

ImapServerInput​

Input object for IMAP server details.

input ImapServerInput {
  encryption: EncryptionType
  host: String!
  id: ID
  password: String
  port: Int!
  username: String!
  verified: Boolean
}

Import2CreateInput​

Autogenerated input type of Import2Create

input Import2CreateInput {
  tool: String!
  clientMutationId: String
}

ImportMutationInput​

Autogenerated input type of ImportMutation

input ImportMutationInput {
  channelId: ID!
  startAt: ISO8601DateTime!
  endAt: ISO8601DateTime!
  clientMutationId: String
}

IntegrationDeleteByProviderInput​

Autogenerated input type of IntegrationDeleteByProvider

input IntegrationDeleteByProviderInput {
  provider: IntegrationProvider!
  clientMutationId: String
}

IntegrationDeleteInput​

Autogenerated input type of IntegrationDelete

input IntegrationDeleteInput {
  integrationId: ID!
  clientMutationId: String
}

IntegrationJiraServerCreateInput​

Autogenerated input type of IntegrationJiraServerCreate

input IntegrationJiraServerCreateInput {
  url: String!
  username: String!
  password: String
  clientMutationId: String
}

IntegrationProviderSettingsUpdateInput​

Autogenerated input type of IntegrationProviderSettingsUpdate

input IntegrationProviderSettingsUpdateInput {
  provider: IntegrationProvider!
  settings: JSON!
  clientMutationId: String
}

IntegrationSettingsUpdateInput​

Autogenerated input type of IntegrationSettingsUpdate

input IntegrationSettingsUpdateInput {
  integrationId: ID!
  settings: JSON!
  clientMutationId: String
}

IntegrationsFilter​

No description

input IntegrationsFilter {
  provider: IntegrationProvider
}

KbArticleDeleteInput​

Autogenerated input type of KbArticleDelete

input KbArticleDeleteInput {
  articleId: ID!
  clientMutationId: String
}

KbSlugAvailabilityInput​

Autogenerated input type of KbSlugAvailability

input KbSlugAvailabilityInput {
  value: ID!
  knowledgeBaseId: ID!
  clientMutationId: String
}

KbSubdomainAvailabilityInput​

Autogenerated input type of KbSubdomainAvailability

input KbSubdomainAvailabilityInput {
  value: ID!
  clientMutationId: String
}

LinkedResourcesFilterInput​

No description

input LinkedResourcesFilterInput {
  conversationId: ID
  conversationIds: [ID!]
}

LoginInput​

Autogenerated input type of Login

input LoginInput {
  subdomain: String!
  email: String!
  password: String!
  csid: String
  clientMutationId: String
}

MobileNotificationPreferencesUpsertInput​

Autogenerated input type of MobileNotificationPreferencesUpsert

input MobileNotificationPreferencesUpsertInput {
  conversationCreated: Boolean
  conversationAssignedToMe: Boolean
  conversationAssignedToMyTeam: Boolean
  conversationAssignedToOtherAgent: Boolean
  agentRepliesToMyConversation: Boolean
  agentRepliesToConversationAssignedToMyTeam: Boolean
  agentRepliesToConversationAssignedToOtherAgent: Boolean
  agentRepliesToUnassignedConversation: Boolean
  agentMention: Boolean
  customerRepliesToMyConversation: Boolean
  customerRepliesToConversationAssignedToMyTeam: Boolean
  customerRatesConversationAssignedToMe: Boolean
  customerRatesConversationAssignedToMyTeam: Boolean
  customerRatesConversationAssignedToOtherAgent: Boolean
  clientMutationId: String
}

NoteMessageInput​

No description

input NoteMessageInput {
  subject: String!
  body: String!
  to: EmailRecipientInput
  phone: String
  attachments: [EmailAttachmentInput!]
}

PinnedSearchFilter​

No description

input PinnedSearchFilter {
  agentId: ID
}

PinnedSearchOrder​

No description

input PinnedSearchOrder {
  field: PinnedSearchOrderField
  direction: OrderDirection
}

PushTokenClearNotificationCountInput​

Autogenerated input type of PushTokenClearNotificationCount

input PushTokenClearNotificationCountInput {
  pushTokenId: ID!
  clientMutationId: String
}

PushTokenCreateInput​

Autogenerated input type of PushTokenCreate

input PushTokenCreateInput {
  token: String!
  clientMutationId: String
}

PushTokenDeleteInput​

Autogenerated input type of PushTokenDelete

input PushTokenDeleteInput {
  pushTokenId: ID!
  clientMutationId: String
}

RoomFilter​

No description

input RoomFilter {
  channelId: ID
  folderId: ID
  contactId: ID
  channelType: RoomChannelTypeEnum
}

RoomOrder​

No description

input RoomOrder {
  field: RoomOrderField
  direction: OrderDirection
}

RuleConditionInput​

Input type for a folder condition, which defines the logic for filtering conversations.

input RuleConditionInput {
  id: ID
  param: RuleConditionParam!
  operator: RuleConditionOperator!
  value: String
  sourceId: String
}

RuleCreateInput​

Autogenerated input type of RuleCreate

input RuleCreateInput {
  name: String!
  description: String
  matchType: RuleMatchTypes!
  state: RuleState!
  position: Int
  triggers: [TriggerInput!]!
  conditions: [RuleConditionInput!]!
  actions: [ActionInput!]!
  scheduleType: ScheduleType!
  scheduleSettings: FeatureTemplateRuleScheduleSettingsInput
  stopUpcoming: Boolean!
  clientMutationId: String
}

RuleDeleteInput​

Autogenerated input type of RuleDelete

input RuleDeleteInput {
  ruleId: ID!
  clientMutationId: String
}

RuleFilter​

No description

input RuleFilter {
  state: RuleState
}

RuleOrder​

No description

input RuleOrder {
  field: RuleOrderField
  direction: OrderDirection
}

RuleReplyTemplateInput​

Input type for an email message template used by rules.

input RuleReplyTemplateInput {
  id: ID
  body: String!
  subject: String
  title: String
  attachmentIds: [ID!]
}

RuleUpdateInput​

Autogenerated input type of RuleUpdate

input RuleUpdateInput {
  ruleId: ID!
  name: String!
  description: String
  matchType: RuleMatchTypes!
  state: RuleState!
  position: Int
  triggers: [TriggerInput!]!
  conditions: [RuleConditionInput!]!
  actions: [ActionInput!]!
  scheduleType: ScheduleType
  scheduleSettings: FeatureTemplateRuleScheduleSettingsInput
  stopUpcoming: Boolean!
  clientMutationId: String
}

SmtpServerInput​

Input object for SMTP server details.

input SmtpServerInput {
  authentication: String!
  encryption: EncryptionType
  host: String!
  id: ID
  password: String
  port: Int!
  username: String!
  verified: Boolean
}

StarredCannedReplyCreateInput​

Autogenerated input type of StarredCannedReplyCreate

input StarredCannedReplyCreateInput {
  cannedReplyId: ID!
  clientMutationId: String
}

StarredCannedReplyDeleteInput​

Autogenerated input type of StarredCannedReplyDelete

input StarredCannedReplyDeleteInput {
  cannedReplyId: ID!
  clientMutationId: String
}

SubjectWithCustomFieldsInput​

No description

input SubjectWithCustomFieldsInput {
  subjectId: ID!
  customFieldList: [CustomFieldListInput!]!
}

SuggestionFilterInput​

No description

input SuggestionFilterInput {
  conversationId: ID!
}

SuggestionUpsertInput​

Autogenerated input type of SuggestionUpsert

input SuggestionUpsertInput {
  suggestionType: AiConversationSuggestionType!
  conversationId: ID!
  suggestionId: ID
  clientMutationId: String
}

SyncRpcInput​

Autogenerated input type of SyncRpc

input SyncRpcInput {
  service: String!
  method: String!
  params: JSON
  clientMutationId: String
}

TagBatchDeleteInput​

Autogenerated input type of TagBatchDelete

input TagBatchDeleteInput {
  filter: TagFilter
  tagIds: [ID!]
  clientMutationId: String
}

TagCreateInput​

Autogenerated input type of TagCreate

input TagCreateInput {
  color: String
  name: String!
  clientMutationId: String
}

TagDeleteInput​

Autogenerated input type of TagDelete

input TagDeleteInput {
  tagId: ID!
  clientMutationId: String
}

TagFilter​

No description

input TagFilter {
  ids: [ID!]
  names: [String!]
  search: String
  conversationStates: [ConversationState!]
  state: TagState
  channelId: ID
  lastUsedAfter: DateTime
}

TagMergeInput​

Autogenerated input type of TagMerge

input TagMergeInput {
  parentTagId: ID!
  filter: TagFilter
  tagIds: [ID!]
  clientMutationId: String
}

TagOrder​

No description

input TagOrder {
  field: TagOrderField
  direction: OrderDirection
}

TagUpdateInput​

Autogenerated input type of TagUpdate

input TagUpdateInput {
  color: String
  tagId: ID!
  name: String
  clientMutationId: String
}

TeamFilter​

No description

input TeamFilter {
  channelId: ID
}

TeamOrder​

No description

input TeamOrder {
  field: TeamOrderField
  direction: OrderDirection
}

teamsCreateInput​

Autogenerated input type of teamsCreate

input teamsCreateInput {
  name: String!
  description: String
  agentIds: [ID!]
  clientMutationId: String
}

teamsDestroyInput​

Autogenerated input type of teamsDestroy

input teamsDestroyInput {
  teamId: ID!
  clientMutationId: String
}

teamsUpdateInput​

Autogenerated input type of teamsUpdate

input teamsUpdateInput {
  teamId: ID!
  name: String
  description: String
  agentIds: [String!]
  clientMutationId: String
}

TriggerInput​

No description

input TriggerInput {
  id: ID
  type: RuleTriggerType!
  settings: JSON
}

UpdatePresenceInput​

Autogenerated input type of UpdatePresence

input UpdatePresenceInput {
  presenceStatus: PresenceStatusType!
  clientMutationId: String
}

UploadPayloadGenerateInput​

Autogenerated input type of UploadPayloadGenerate

input UploadPayloadGenerateInput {
  fileName: String!
  clientMutationId: String
}

WalletOptionsInput​

No description

input WalletOptionsInput {
  userOnly: Boolean
}

WalletTransactionCreateInput​

Autogenerated input type of WalletTransactionCreate

input WalletTransactionCreateInput {
  feature: String!
  clientMutationId: String
}

WalletUpdateInput​

Autogenerated input type of WalletUpdate

input WalletUpdateInput {
  autorenew: Boolean
  autorenewAmount: Int
  autorenewThreshold: Int
  autorenewUses: Int
  walletId: ID!
  clientMutationId: String
}

WebhookCreateInput​

Autogenerated input type of WebhookCreate

input WebhookCreateInput {
  event: WebhookEvent!
  url: String!
  clientMutationId: String
}

WebhookDeleteInput​

Autogenerated input type of WebhookDelete

input WebhookDeleteInput {
  webhookId: ID!
  clientMutationId: String
}

WebhookFilterInput​

Filters for webhook lists.

input WebhookFilterInput {
  event: WebhookEvent
  state: WebhookState
}

WebhookReactivateInput​

Autogenerated input type of WebhookReactivate

input WebhookReactivateInput {
  webhookId: ID!
  clientMutationId: String
}

WebhookTestInput​

Autogenerated input type of WebhookTest

input WebhookTestInput {
  webhookId: ID!
  clientMutationId: String
}

WebhookUpdateInput​

Autogenerated input type of WebhookUpdate

input WebhookUpdateInput {
  event: WebhookEvent
  url: String
  webhookId: ID!
  clientMutationId: String
}

WidgetFilter​

No description

input WidgetFilter {
  channelType: WidgetChannelType
}

WidgetHelplyProvisionInput​

Autogenerated input type of WidgetHelplyProvision

input WidgetHelplyProvisionInput {
  clientMutationId: String
}