Skip to main content

object

ContactCondition

LLM
View as Markdown
Open llms.txt

Variants

Use type to choose one of `searchText`, `archiveStatus`, `createdAt`, `firstSeen`, `lastInteraction`, `chatCount`, `customFieldText`, `customFieldDate`, `hasAnyTag`, `hasAnyChannel`.

SearchTextCondition

searchText

Required: `type`, `text`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: searchText.
  • Name
    text
    Type
    string
    Description
    Required property.

Example

searchText
{
  "type": "searchText",
  "text": "string"
}

ArchiveStatusCondition

archiveStatus

Required: `type`, `status`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: archiveStatus.
  • Name
    status
    Type
    ArchiveStatus
    Description
    Required property.

Example

archiveStatus
{
  "type": "archiveStatus",
  "status": "active"
}

CreatedAtCondition

createdAt

Required: `type`, `operator`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: createdAt.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: before, after, between, olderThanDays, newerThanDays.
  • Name
    start
    Type
    string
    Description
    Optional property.
  • Name
    end
    Type
    string
    Description
    Optional property.
  • Name
    days
    Type
    integer
    Description
    Optional property.

Example

createdAt
{
  "type": "createdAt",
  "operator": "before",
  "start": "string",
  "end": "string",
  "days": 0
}

FirstSeenCondition

firstSeen

Required: `type`, `operator`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: firstSeen.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: before, after, between, olderThanDays, newerThanDays, exists, notExists.
  • Name
    start
    Type
    string
    Description
    Optional property.
  • Name
    end
    Type
    string
    Description
    Optional property.
  • Name
    days
    Type
    integer
    Description
    Optional property.

Example

firstSeen
{
  "type": "firstSeen",
  "operator": "before",
  "start": "string",
  "end": "string",
  "days": 0
}

LastInteractionCondition

lastInteraction

Required: `type`, `operator`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: lastInteraction.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: before, after, between, olderThanDays, newerThanDays, exists, notExists.
  • Name
    start
    Type
    string
    Description
    Optional property.
  • Name
    end
    Type
    string
    Description
    Optional property.
  • Name
    days
    Type
    integer
    Description
    Optional property.

Example

lastInteraction
{
  "type": "lastInteraction",
  "operator": "before",
  "start": "string",
  "end": "string",
  "days": 0
}

ChatCountCondition

chatCount

Required: `type`, `operator`, `window`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: chatCount.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: atLeast, atMost, between.
  • Name
    min
    Type
    integer
    Description
    Optional property.
  • Name
    max
    Type
    integer
    Description
    Optional property.
  • Name
    window
    Type
    EngagementWindow
    Description
    Required property.

Example

chatCount
{
  "type": "chatCount",
  "operator": "atLeast",
  "min": 0,
  "max": 0,
  "window": {
    "type": "lifetime",
    "days": 0
  }
}

CustomFieldTextCondition

customFieldText

Required: `type`, `fieldId`, `operator`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: customFieldText.
  • Name
    fieldId
    Type
    string
    Description
    Required property.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: equals, notEquals, in, exists, notExists.
  • Name
    value
    Type
    string
    Description
    Optional property.
  • Name
    values
    Type
    array<string>
    Description
    Optional property.

Example

customFieldText
{
  "type": "customFieldText",
  "fieldId": "string",
  "operator": "equals",
  "value": "string",
  "values": [
    "string"
  ]
}

CustomFieldDateCondition

customFieldDate

Required: `type`, `fieldId`, `operator`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: customFieldDate.
  • Name
    fieldId
    Type
    string
    Description
    Required property.
  • Name
    operator
    Type
    enum
    Description
    Required property. Allowed values: before, after, between, olderThanDays, newerThanDays, exists, notExists.
  • Name
    start
    Type
    string
    Description
    Optional property.
  • Name
    end
    Type
    string
    Description
    Optional property.
  • Name
    days
    Type
    integer
    Description
    Optional property.

Example

customFieldDate
{
  "type": "customFieldDate",
  "fieldId": "string",
  "operator": "before",
  "start": "string",
  "end": "string",
  "days": 0
}

HasAnyTagCondition

hasAnyTag

Required: `type`, `tagIds`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: hasAnyTag.
  • Name
    tagIds
    Type
    array<string>
    Description
    Required property.

Example

hasAnyTag
{
  "type": "hasAnyTag",
  "tagIds": [
    "string"
  ]
}

HasAnyChannelCondition

hasAnyChannel

Required: `type`, `channels`.

  • Name
    type
    Type
    enum
    Description
    Required property. Allowed values: hasAnyChannel.
  • Name
    channels
    Type
    array<ContactChannel>
    Description
    Required property.

Example

hasAnyChannel
{
  "type": "hasAnyChannel",
  "channels": [
    "whatsapp"
  ]
}

Related operations