Sign in
Account

Get the account's sequence delivery settings

Returns the account-level Sequence settings: allowMultipleActiveSequences, maxConcurrentActiveSequences, the account's defaultDeliveryWindow override (null if never set), accountTimezone, effectiveDeliveryWindow — the window actually applied when a Sequence's own deliveryWindow is null (defaultDeliveryWindow, or the hardcoded Mon-Fri 09:00-17:00 fallback) — and enrollOnBehalfPolicy, which governs the enroll and enroll-bulk endpoints' enrollerUserId field. Use this before assuming deliveryWindow: null on a Sequence means unrestricted / 24-7 delivery — it does not. Requires a USER API key belonging to an OWNER or ADMIN.

get/public/v1/account/sequence-settings

Response

Account Sequence settings

allowMultipleActiveSequencesboolean required
maxConcurrentActiveSequencesinteger nullable required
accountTimezonestring required
enrollOnBehalfPolicy'NONE' | 'ADMINS_AND_OWNERS' | 'ALL_USERS' required

Example response

{
  "defaultDeliveryWindow": {
    "allowedWeekdays": [
      1
    ]
  },
  "accountTimezone": "America/Argentina/Buenos_Aires",
  "effectiveDeliveryWindow": {
    "startTime": "09:00",
    "endTime": "17:00",
    "allowedWeekdays": [
      1,
      2,
      3,
      4,
      5
    ]
  },
  "enrollOnBehalfPolicy": "NONE"
}

Changes

Changed in 1 of the 2 revisions of this API.1