REreteno
Messages

Search for Email messages

The method is used to search for Email messages using a part of their name or a tag. By default, a rate limit of 500 requests per hour applies. <br/>The method returns a maximum of 500 messages per request. <br/>The <b>TotalCount</b> header contains the number of messages returned to the query.

get/api/v1/messages/email

Request

Query parameters

searchstring

Search condition (a part of the message name or a tag)

startindexinteger

The index of the first message to return from the search result.<br/>Numbering starts at 1

maxrowsinteger

Maximum number of messages to return (max. 500).

Response

idinteger

Message ID.

namestring required

Message name.

languageCodestring

Language code.

tagsstring[]

List of tags.

subscriptionsKeysstring[]

Subscription categories keys, assigned to a message.

languagesstring[]

An array with the language codes for multilingual messages. Available for the GET method only.

fromstring required

<b>Required parameter</b> for a regular message (template = false or absent).<br> Sender name and email address, e.g. "from": ""name" <info@test.com>".<br> If template = true, the parameter is optional: if your organization has email senders, the first one is assigned to the template; otherwise, the template is created without a sender.

subjectstring required

Message subject

htmlTextstring required

Message HTML code

rawHtmlstring

Message HTML code without styles.

ampHtmlstring

Message AMP code

cssstring

Message styles

updatedDatestring date-time

Message updated date

templateboolean

Set to true to create the message as a template. If false or absent, a general message is created.

Example response

[
  {
    "from": "\"John Smith\" John.Smith@example.com",
    "subject": "Thanks for signing up",
    "translations": [
      {
        "from": "\"John Smith\" John.Smith@example.com",
        "subject": "Thanks for signing up"
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 2 revisions of this API.