ListContactFrequencyRulesResponse

result objectrequired

Response information.

elements object[]required

Array [

targetIdstring

The ids of the target. For mailing lists, this will be mailing list ids, for directories this will be directoryId, for surveys this will be surveyId.

targetTypestringrequired

The targetType for this rule. Must be ONE of the following: Directory, MailingList, Survey.

Possible values: [Directory, MailingList, Survey]

targetIdsstring[]required

The ids of the target. For mailing lists, this will be mailing list ids, for directories this will be directoryId, for surveys this will be surveyId.

emailTypestringrequired

The types of email the rule applies to. Valid values are: Invite or Email. Email is for any email message, including invites.

Possible values: [Invite, Email]

daysBetweeninteger<int32>nullable

The days between invites or emails.

timePeriodLimit objectnullable

Defines the maximum number of messages a contact can receive in a given time period. This is a object with two fields: period, numMessages. numMessages is an integer and period can be Day, Week, or Month.

periodstring

Time period.

Possible values: [Day, Week, Month]

numMessagesinteger<int32>

Number of messages returned.

Possible values: >= 0

alwaysSendboolean

Turns on alwaysSend. If turned on, when this Contact Frequency rule conflicts with another Contact Frequency rule, this distribution will ignore the conflict and send the distribution.

ruleIdRuleId (string)

The contact frequency Rule ID.

Example: FQ_AAB234234

mutuallyExclusivebooleannullable

Whether returned values are mutually exclusive.

]

nextPageNextPage (string)nullable

Page number of result if response is divided across several pages. For the last page of results, the value returned is null.

meta objectrequired

Response metadata.

httpStatushttp status (string)required

HTTP status code.

requestIdAn identifier of the incoming request. (string)required

The unique identifier of the associated request.

noticeAn informational string about the request. (string)

An informational string about the request.

ListContactFrequencyRulesResponse

{
  "result": {
    "elements": [
      {
        "targetId": "string",
        "targetType": "Directory",
        "targetIds": [
          "string"
        ],
        "emailType": "Invite",
        "daysBetween": 0,
        "timePeriodLimit": {
          "period": "Day",
          "numMessages": 0
        },
        "alwaysSend": true,
        "ruleId": "FQ_AAB234234",
        "mutuallyExclusive": true
      }
    ],
    "nextPage": "string"
  },
  "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
  }
}