Set Limit method 🪪 Sub-Accounts

Sets the limit for the specified sub-account.

Usage

modular.ts

import { MailChannelsClient, SubAccounts } from 'mailchannels-sdk'

const mailchannels = new MailChannelsClient('your-api-key')
const subAccounts = new SubAccounts(mailchannels)

const { success, error } = await subAccounts.setLimit('validhandle123', { sends: 1000 })

full.ts

import { MailChannels } from 'mailchannels-sdk'

const mailchannels = new MailChannels('your-api-key')

const { success, error } = await mailchannels.subAccounts.setLimit('validhandle123', { sends: 1000 })

Params

• handle string required: The handle of the sub-account to set the limit for.
• limits object required: The limits to set for the sub-account.
  • sends number required

  TIP

  The minimum allowed sends is 0.

Response

• success boolean guaranteed: Whether the operation was successful.
• error ErrorResponse | null nullable: Error information if the operation failed.
  • message string guaranteed: A human-readable description of the error.
  • statusCode number | null nullable: The HTTP status code from the API, or null if the error is not related to an HTTP request. This field is intended for diagnostic use only and should not be relied upon.
  • type string guaranteed: A string identifier for the type of error. This field is intended for diagnostic use only and should not be relied upon.

Type declarations

Signature

async function setLimit (handle: string, limit: SubAccountsLimit): Promise<SuccessResponse>

Response type declarations

interface ErrorResponse {
  message: string;
  statusCode: number | null;
  type: ErrorType;
}

interface SuccessResponse {
  success: boolean;
  error: ErrorResponse | null;
}

Limit type declaration

interface SubAccountsLimit {
  sends: number;
}

Source

Source • Playground • Docs • Tests