Parameters

NameTypeRequiredDescription
brandIdstringYesOcoya brand id from ocoya_list_brands.
statusesstring[]NoOnly emails with these statuses.
querystringNoSearch by name or subject.
campaignIdstringNoOnly the emails of this email campaign.
standalonebooleanNoOnly emails that are not part of a campaign.
pagenumberNoZero-based page number. Defaults to 0.
perPagenumberNoEmails per page, up to 100. Defaults to 20.

Request example

{
  "name": "ocoya_list_emails",
  "arguments": {
    "brandId": "cmayvq3hk00017apshay5qezu",
    "query": "launch"
  }
}

Returns

Returns the result of the call as JSON. This tool only reads: it changes nothing in Ocoya.