Input objects


ActionInput

Arguments

  • Name
    config
    Type
    JSON
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    icon
    Type
    String
    Description
  • Name
    id
    Type
    String
    Description
  • Name
    label
    Type
    String
    Description
  • Name
    nextActionId
    Type
    String
    Description
  • Name
    style
    Type
    JSON
    Description
  • Name
    type
    Type
    String
    Description

AttachmentInput

Arguments

  • Name
    duration
    Type
    Float
    Description
  • Name
    name
    Type
    String!
    Description
  • Name
    size
    Type
    Float
    Description
  • Name
    type
    Type
    String
    Description
  • Name
    url
    Type
    String!
    Description

BookingStyleInput

Arguments

  • Name
    baseFont
    Type
    String
    Description
  • Name
    columns
    Type
    Int
    Description
  • Name
    itemShape
    Type
    String
    Description
  • Name
    line
    Type
    String
    Description
  • Name
    margin
    Type
    Int
    Description
  • Name
    productAvailable
    Type
    String
    Description
  • Name
    rows
    Type
    Int
    Description
  • Name
    widgetColor
    Type
    String
    Description

ClientPortalUserUpdate

Arguments

  • Name
    avatar
    Type
    String
    Description
  • Name
    code
    Type
    String
    Description
  • Name
    companyName
    Type
    String
    Description
  • Name
    companyRegistrationNumber
    Type
    String
    Description
  • Name
    customFieldsData
    Type
    JSON
    Description
  • Name
    email
    Type
    String
    Description
  • Name
    firstName
    Type
    String
    Description
  • Name
    isEmailVerified
    Type
    Boolean
    Description
  • Name
    isOnline
    Type
    Boolean
    Description
  • Name
    isPhoneVerified
    Type
    Boolean
    Description
  • Name
    lastName
    Type
    String
    Description
  • Name
    links
    Type
    JSON
    Description
  • Name
    phone
    Type
    String
    Description
  • Name
    username
    Type
    String
    Description

ConversationMessageParams

Arguments

  • Name
    content
    Type
    String
    Description
  • Name
    conversationId
    Type
    String
    Description
  • Name
    createdAt
    Type
    Date
    Description
  • Name
    line
    Type
    String
    Description
  • Name
    customerId
    Type
    String
    Description
  • Name
    internal
    Type
    Boolean
    Description
  • Name
    isCustomerRead
    Type
    Boolean
    Description
  • Name
    mentionedUserIds
    Type
    [String]
    Description
  • Name
    userId
    Type
    String
    Description

CoordinateInput

Arguments

  • Name
    latitude
    Type
    String
    Description
  • Name
    longitude
    Type
    String
    Description

EmailSignature

  • Name
    brandId
    Type
    String
    Description
  • Name
    signature
    Type
    String
    Description

EngageMessageSmsInput

  • Name
    content
    Type
    String!
    Description
  • Name
    from
    Type
    String
    Description
  • Name
    fromIntegrationId
    Type
    String
    Description

EngageMessageEmail

  • Name
    attachments
    Type
    [JSON]
    Description
  • Name
    content
    Type
    String
    Description
  • Name
    replyTo
    Type
    String
    Description
  • Name
    sender
    Type
    String
    Description
  • Name
    subject
    Type
    String!
    Description
  • Name
    templateId
    Type
    String
    Description

EngageMessageMessenger

  • Name
    brandId
    Type
    String!
    Description
  • Name
    content
    Type
    String
    Description
  • Name
    kind
    Type
    String
    Description
  • Name
    rules
    Type
    [InputRule]
    Description
  • Name
    sentAs
    Type
    String!
    Description

EngageScheduleDateInput

  • Name
    dateTime
    Type
    date
    Description
  • Name
    day
    Type
    String
    Description
  • Name
    month
    Type
    String
    Description
  • Name
    type
    Type
    String
    Description

EventAttributeFilter

  • Name
    name
    Type
    String
    Description
  • Name
    operator
    Type
    String
    Description
  • Name
    value
    Type
    String
    Description

ExmAppearanceInput

  • Name
    primaryColor
    Type
    String
    Description
  • Name
    secondaryColor
    Type
    String
    Description

ExmEventDataInput

  • Name
    endDate
    Type
    Date
    Description
  • Name
    startDate
    Type
    Date
    Description
  • Name
    visibility
    Type
    String
    Description
  • Name
    where
    Type
    String
    Description

ExmFeatureInput

  • Name
    _id
    Type
    String
    Description
  • Name
    contentId
    Type
    String
    Description
  • Name
    contentType
    Type
    String
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    icon
    Type
    String
    Description
  • Name
    name
    Type
    String
    Description
  • Name
    subContentId
    Type
    String
    Description

ExmWelcomeContentInput

  • Name
    _id
    Type
    String
    Description
  • Name
    content
    Type
    String
    Description
  • Name
    image
    Type
    AttachmentInput
    Description
  • Name
    title
    Type
    String
    Description

FieldItem

Arguments

  • Name
    _id
    Type
    JSON
    Description
  • Name
    associatedFieldId
    Type
    String
    Description
  • Name
    code
    Type
    String
    Description
  • Name
    column
    Type
    Int
    Description
  • Name
    content
    Type
    String
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    field
    Type
    JSON
    Description
  • Name
    groupName
    Type
    String
    Description
  • Name
    isDefinedByErxes
    Type
    Boolean
    Description
  • Name
    isRequired
    Type
    Boolean
    Description
  • Name
    isVisibleToCreate
    Type
    Boolean
    Description
  • Name
    locationOptions
    Type
    [LocationOptionInput]
    Description
  • Name
    logicAction
    Type
    String
    Description
  • Name
    logics
    Type
    [LogicInput]
    Description
  • Name
    objectListConfigs
    Type
    [objectListConfigInput]
    Description
  • Name
    options
    Type
    [String]
    Description
  • Name
    optionsValues
    Type
    String
    Description
  • Name
    order
    Type
    Int
    Description
  • Name
    pageNumber
    Type
    Int
    Description
  • Name
    productCategoryId
    Type
    String
    Description
  • Name
    searchable
    Type
    Boolean
    Description
  • Name
    showInCard
    Type
    Boolean
    Description
  • Name
    tempFieldId
    Type
    String
    Description
  • Name
    text
    Type
    String
    Description
  • Name
    type
    Type
    String
    Description
  • Name
    validation
    Type
    String
    Description

FieldValueInput

Arguments

  • Name
    _id
    Type
    String!
    Description
  • Name
    associatedFieldId
    Type
    String
    Description
  • Name
    column
    Type
    Int
    Description
  • Name
    groupId
    Type
    String
    Description
  • Name
    productId
    Type
    String!
    Description
  • Name
    stageId
    Type
    String
    Description
  • Name
    text
    Type
    String
    Description
  • Name
    type
    Type
    String
    Description
  • Name
    validation
    Type
    String
    Description
  • Name
    value
    Type
    JSON
    Description

FormCodeInput

Arguments

  • Name
    brandId
    Type
    String
    Description
  • Name
    formId
    Type
    String
    Description

FormSubmissionInput

Arguments

  • Name
    _id
    Type
    String!
    Description
  • Name
    value
    Type
    JSON
    Description

IMovementItem

Arguments

  • Name
    assetId
    Type
    String
    Description
  • Name
    assetName
    Type
    String
    Description
  • Name
    branchId
    Type
    String
    Description
  • Name
    companyId
    Type
    String
    Description
  • Name
    customerId
    Type
    String
    Description
  • Name
    departmentId
    Type
    String
    Description
  • Name
    teamMemberId
    Type
    String
    Description

InputRule

Arguments

  • Name
    _id
    Type
    String!
    Description
  • Name
    condition
    Type
    String!
    Description
  • Name
    kind
    Type
    String!
    Description
  • Name
    text
    Type
    String!
    Description
  • Name
    value
    Type
    String
    Description

IntegrationBookingData

Arguments

  • Name
    bookingFormText
    Type
    String
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    image
    Type
    AttachmentInput
    Description
  • Name
    name
    Type
    String
    Description
  • Name
    navigationText
    Type
    String
    Description
  • Name
    productCategoryId
    Type
    String
    Description
  • Name
    productFieldIds
    Type
    [String]
    Description
  • Name
    style
    Type
    BookingStyleInput
    Description

Arguments

  • Name
    facebook
    Type
    String
    Description
  • Name
    twitter
    Type
    String
    Description
  • Name
    youtube
    Type
    String
    Description

IntegrationLeadData

Arguments

  • Name
    adminEmailContent
    Type
    String
    Description
  • Name
    adminEmailTitle
    Type
    String
    Description
  • Name
    adminEmails
    Type
    [String]
    Description
  • Name
    attachments
    Type
    [AttachmentInput]
    Description
  • Name
    callout
    Type
    JSON
    Description
  • Name
    css
    Type
    String
    Description
  • Name
    fromEmail
    Type
    String
    Description
  • Name
    isRequireOnce
    Type
    Boolean
    Description
  • Name
    loadType
    Type
    String
    Description
  • Name
    redirectUrl
    Type
    String
    Description
  • Name
    rules
    Type
    [InputRule]
    Description
  • Name
    saveAsCustomer
    Type
    Boolean
    Description
  • Name
    successAction
    Type
    String
    Description
  • Name
    successImage
    Type
    String
    Description
  • Name
    successImageSize
    Type
    String
    Description
  • Name
    templateId
    Type
    String
    Description
  • Name
    thankContent
    Type
    String
    Description
  • Name
    thankTitle
    Type
    String
    Description
  • Name
    themeColor
    Type
    String
    Description
  • Name
    userEmailContent
    Type
    String
    Description
  • Name
    userEmailTitle
    Type
    String
    Description

IntegrationMessengerData

Arguments

  • Name
    _id
    Type
    String
    Description
  • Name
    availabilityMethod
    Type
    String
    Description
  • Name
    botEndpointUrl
    Type
    String
    Description
  • Name
    botShowInitialMessage
    Type
    Boolean
    Description
  • Name
    forceLogoutWhenResolve
    Type
    Boolean
    Description
  • Name
    isOnline
    Type
    Boolean
    Description
  • Name
    knowledgeBaseTopicId
    Type
    String
    Description
  • Name
    links
    Type
    IntegrationLinks
    Description
  • Name
    messages
    Type
    JSON
    Description
  • Name
    notifyCustomer
    Type
    Boolean
    Description
  • Name
    onlineHours
    Type
    [MessengerOnlineHoursSchema]
    Description
  • Name
    requireAuth
    Type
    Boolean
    Description
  • Name
    responseRate
    Type
    String
    Description
  • Name
    showChat
    Type
    Boolean
    Description
  • Name
    showLauncher
    Type
    Boolean
    Description
  • Name
    showTimezone
    Type
    Boolean
    Description
  • Name
    showVideoCallRequest
    Type
    Boolean
    Description
  • Name
    skillData
    Type
    JSON
    Description
  • Name
    supporterIds
    Type
    [String]
    Description
  • Name
    timezone
    Type
    String
    Description

Interval

Arguments

  • Name
    endTime
    Type
    Date
    Description
  • Name
    startTime
    Type
    Date
    Description

ItemDate

Arguments

  • Name
    month
    Type
    Int
    Description
  • Name
    year
    Type
    Int
    Description

InvitationEntry

Arguments

  • Name
    branchId
    Type
    String
    Description
  • Name
    channelIds
    Type
    [String]
    Description
  • Name
    departmentId
    Type
    String
    Description
  • Name
    email
    Type
    String
    Description
  • Name
    groupId
    Type
    String
    Description
  • Name
    password
    Type
    String
    Description
  • Name
    unitId
    Type
    String
    Description

KnowledgeBaseArticleDoc

Arguments

  • Name
    attachments
    Type
    [AttachmentInput]
    Description
  • Name
    categoryId
    Type
    String
    Description
  • Name
    categoryIds
    Type
    [String]
    Description
  • Name
    content
    Type
    String!
    Description
  • Name
    forms
    Type
    [FormCodeInput]
    Description
  • Name
    image
    Type
    AttachmentInput
    Description
  • Name
    reactionChoices
    Type
    [String]
    Description
  • Name
    status
    Type
    String!
    Description
  • Name
    summary
    Type
    String
    Description
  • Name
    title
    Type
    String!
    Description
  • Name
    topicId
    Type
    String
    Description

KnowledgeBaseCategoryDoc

Arguments

  • Name
    articleIds
    Type
    [String]
    Description
  • Name
    description
    Type
    [String]
    Description
  • Name
    icon
    Type
    String!
    Description
  • Name
    parentCategoryId
    Type
    String
    Description
  • Name
    title
    Type
    String!
    Description
  • Name
    topicId
    Type
    String
    Description
  • Name
    topicIds
    Type
    [String]
    Description

KnowledgeBaseMessengerAppInput

Arguments

  • Name
    topicId
    Type
    String
    Description

KnowledgeBaseTopicDoc

Arguments

  • Name
    backgroundImage
    Type
    String
    Description
  • Name
    brandId
    Type
    String!
    Description
  • Name
    categoryIds
    Type
    [String]
    Description
  • Name
    color
    Type
    String
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    languageCode
    Type
    String
    Description
  • Name
    notificationSegmentId
    Type
    String
    Description
  • Name
    title
    Type
    String!
    Description

LeadMessengerAppInput

Arguments

  • Name
    formCode
    Type
    String
    Description

LocationOptionInput

Arguments

  • Name
    description
    Type
    String
    Description
  • Name
    lat
    Type
    Float
    Description
  • Name
    lng
    Type
    Float
    Description

LogicInput

Arguments

  • Name
    fieldId
    Type
    String
    Description
  • Name
    logicOperator
    Type
    String
    Description
  • Name
    logicValue
    Type
    JSON
    Description
  • Name
    tempFieldId
    Type
    String
    Description

MailConfigInput

Arguments

  • Name
    invitationContent
    Type
    String
    Description
  • Name
    registrationContent
    Type
    String
    Description
  • Name
    subject
    Type
    String
    Description

MessengerAppsInput

Arguments

  • Name
    knowledgebases
    Type
    [KnowledgeBaseMessengerAppInput]
    Description
  • Name
    leads
    Type
    [LeadMessengerAppInput]
    Description
  • Name
    websites
    Type
    [WebSiteMessengerAppInput]
    Description

MessengerOnlineHoursSchema

Arguments

  • Name
    _id
    Type
    String
    Description
  • Name
    day
    Type
    String
    Description
  • Name
    from
    Type
    String
    Description
  • Name
    to
    Type
    String
    Description

MessengerUiOptions

Arguments

  • Name
    color
    Type
    String
    Description
  • Name
    logo
    Type
    String
    Description
  • Name
    textColor
    Type
    String
    Description
  • Name
    wallpaper
    Type
    String
    Description

NotificationConfigInput

Arguments

  • Name
    isAllowed
    Type
    Boolean
    Description
  • Name
    label
    Type
    String
    Description
  • Name
    notifType
    Type
    String
    Description

objectListConfigInput

Arguments

  • Name
    key
    Type
    String
    Description
  • Name
    label
    Type
    String
    Description
  • Name
    type
    Type
    String
    Description

OrderItem

Arguments

  • Name
    _id
    Type
    String!
    Description
  • Name
    order
    Type
    Int!
    Description

OTPConfigInput

Arguments

  • Name
    codeLength
    Type
    Int
    Description
  • Name
    content
    Type
    String
    Description
  • Name
    expireAfter
    Type
    Int
    Description
  • Name
    loginWithOTP
    Type
    Boolean
    Description
  • Name
    smsTransporterType
    Type
    String
    Description

PipelineTemplateStageInput

Arguments

  • Name
    _id
    Type
    String!
    Description
  • Name
    formId
    Type
    String
    Description
  • Name
    name
    Type
    String!
    Description

ProductField

Arguments

  • Name
    productId
    Type
    String
    Description
  • Name
    quantity
    Type
    Int
    Description

SegmentCondition

Arguments

  • Name
    config
    Type
    JSON
    Description
  • Name
    eventAttributeFilters
    Type
    [EventAttributeFilter]
    Description
  • Name
    eventName
    Type
    String
    Description
  • Name
    eventOccurence
    Type
    Float
    Description
  • Name
    propertyName
    Type
    String
    Description
  • Name
    propertyOperator
    Type
    String
    Description
  • Name
    propertyType
    Type
    String
    Description
  • Name
    propertyValue
    Type
    String
    Description
  • Name
    subSegmentId
    Type
    String
    Description
  • Name
    type
    Type
    String
    Description

StylesParams

Arguments

  • Name
    activeTabColor
    Type
    JSON
    Description
  • Name
    backgroundColor
    Type
    [EventAttributeFilter]
    Description
  • Name
    baseColor
    Type
    String
    Description
  • Name
    baseFont
    Type
    Float
    Description
  • Name
    bodyColor
    Type
    String
    Description
  • Name
    dividerColor
    Type
    String
    Description
  • Name
    footerColor
    Type
    String
    Description
  • Name
    headerColor
    Type
    String
    Description
  • Name
    headingColor
    Type
    String
    Description
  • Name
    headingFont
    Type
    String
    Description
  • Name
    helpColor
    Type
    String
    Description
  • Name
    linkColor
    Type
    String
    Description
  • Name
    linkHoverColor
    Type
    String
    Description
  • Name
    primaryBtnColor
    Type
    String
    Description
  • Name
    secondaryBtnColor
    Type
    String
    Description

ShiftsRequestInput

Arguments

  • Name
    _id
    Type
    String
    Description
  • Name
    configName
    Type
    String
    Description
  • Name
    overnightShift
    Type
    Boolean
    Description
  • Name
    shiftEnd
    Type
    Date
    Description
  • Name
    shiftStart
    Type
    Date
    Description

SubmissionFilter

Arguments

  • Name
    formFieldId
    Type
    String
    Description
  • Name
    operator
    Type
    String
    Description
  • Name
    value
    Type
    JSON
    Description

SubSegment

Arguments

  • Name
    _id
    Type
    String
    Description
  • Name
    conditions
    Type
    JSON
    Description
  • Name
    conditionsConjunction
    Type
    String
    Description
  • Name
    config
    Type
    JSON
    Description
  • Name
    contentType
    Type
    String
    Description

TriggerInput

Arguments

  • Name
    actionId
    Type
    String
    Description
  • Name
    config
    Type
    JSON
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    icon
    Type
    String
    Description
  • Name
    id
    Type
    String
    Description
  • Name
    label
    Type
    String
    Description
  • Name
    style
    Type
    JSON
    Description
  • Name
    type
    Type
    String
    Description

UserDetails

Arguments

  • Name
    avatar
    Type
    String
    Description
  • Name
    birthDate
    Type
    Date
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    employeeId
    Type
    String
    Description
  • Name
    firstName
    Type
    String
    Description
  • Name
    fullName
    Type
    String
    Description
  • Name
    lastName
    Type
    String
    Description
  • Name
    location
    Type
    String
    Description
  • Name
    middleName
    Type
    String
    Description
  • Name
    operatorPhone
    Type
    String
    Description
  • Name
    position
    Type
    String
    Description
  • Name
    shortName
    Type
    String
    Description
  • Name
    workStartedDate
    Type
    Date
    Description

WebSiteMessengerAppInput

Arguments

  • Name
    buttonText
    Type
    String
    Description
  • Name
    description
    Type
    String
    Description
  • Name
    url
    Type
    String
    Description

Was this page helpful?