Skip to main content
QUERY
engageMessages(kind: String, method: String, title: String, status: String, tag: String, customerTag: String, untagged: Boolean, folderTagId: String, ids: [String], page: Int, perPage: Int, searchValue: String): EngageMessagePaginatedResponse

Arguments

kind
String

Filter by campaign kind (e.g. auto, visitorAuto, manual).

method
String

Filter by delivery channel: email, messenger, push, or whatsapp.

title
String

Case-insensitive partial match on campaign title.

status
String

Filter by lifecycle status (e.g. draft, live, paused).

tag
String

Filter to campaigns targeting this conversation/message tag id.

customerTag
String

Filter to campaigns targeting this customer tag id.

untagged
Boolean

When true, only return campaigns with no tags.

folderTagId
String

Filter by tag folder id.

ids
[String]

Return only campaigns matching these ids, in addition to other filters.

page
Int

1-based page index. Default: 1. See Pagination.

perPage
Int

Page size. Default: 20. See Pagination.

searchValue
String

Case-insensitive partial match on title (alias for title).

EngageMessage rows for the current page.

pagination

Standard pagination metadata: totalCount, currentPage, totalPages, hasNextPage, hasPreviousPage, perPage.

Query
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦