Create API Key method 🪪 Sub-Accounts

Creates a new API key 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 { data, error } = await subAccounts.createApiKey('validhandle123')

full.ts

import { MailChannels } from 'mailchannels-sdk'

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

const { data, error } = await mailchannels.subAccounts.createApiKey('validhandle123')

Params

• handle string required: The handle of the sub-account to create API key for.

Response

• data SubAccountsApiKey | null nullable
  • id number guaranteed: The API key ID for the sub-account.
  • key string guaranteed: API key for the sub-account.
• 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 createApiKey (handle: string): Promise<SubAccountsCreateApiKeyResponse>

Response type declarations

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

type DataResponse<T> = {
  data: T;
  error: null;
} | {
  data: null;
  error: ErrorResponse;
};

API Key type declarations

interface SubAccountsApiKey {
  id: number;
  key: string;
}

type SubAccountsCreateApiKeyResponse = DataResponse<SubAccountsApiKey>;

Source

Source • Playground • Docs • Tests