Skip to content

Function: createNote() ​

ts
function createNote(
   client, 
   text, 
   options?
): Promise<{
[key: string]: unknown;
  audience?: number;
  author?: {
   [key: string]: unknown;
     biography?: string;
     external_url?: string | null;
     follower_count?: number | null;
     following_count?: number | null;
     full_name?: string;
     is_private?: boolean;
     is_verified?: boolean;
     media_count?: number | null;
     pk?: string;
     profile_pic_url?: string | null;
     username?: string;
  };
  author_id?: string;
  created_at?: number;
  expires_at?: number;
  is_emoji_only?: boolean;
  note_id: string;
  note_style?: number;
  text?: string;
}>;

Posts a note (a short text, up to 60 characters) and returns it.

Parameters ​

ParameterType
clientPrivateClient
textstring
options?CreateNoteOptions

Returns ​

Promise<{ [key: string]: unknown; audience?: number; author?: { [key: string]: unknown; biography?: string; external_url?: string | null; follower_count?: number | null; following_count?: number | null; full_name?: string; is_private?: boolean; is_verified?: boolean; media_count?: number | null; pk?: string; profile_pic_url?: string | null; username?: string; }; author_id?: string; created_at?: number; expires_at?: number; is_emoji_only?: boolean; note_id: string; note_style?: number; text?: string; }>

MIT License. Not affiliated with, endorsed or sponsored by Meta or Instagram.