Parameters
| Name | Type | Required | Description |
|---|---|---|---|
brandId | string | Yes | Ocoya brand id from ocoya_list_brands. |
query | string | No | Search by email address or name. |
status | string | No | Only contacts with this status. One of subscribed, unsubscribed, bounced, complained. |
groupId | string | No | Only contacts in this group. |
page | number | No | Zero-based page number. Defaults to 0. |
perPage | number | No | Items per page, up to 100. Defaults to 25. |
Request example
{
"name": "ocoya_list_contacts",
"arguments": {
"brandId": "cmayvq3hk00017apshay5qezu",
"query": "launch"
}
}Returns
Returns the result of the call as JSON. This tool only reads: it changes nothing in Ocoya.