Function: editHighlight()

function editHighlight(
   client, 
   id, 
   options
): Promise<{
[key: string]: unknown;
  id: string;
  items?: object[];
  media_count?: number | null;
  title?: string;
  user?: {
   [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;
  };
}>;

Changes a highlight: its title, its stories or its cover.

Parameters

Parameter	Type
client	PrivateClient
id	string
options	EditHighlightOptions

Returns

Promise<{ [key: string]: unknown; id: string; items?: object[]; media_count?: number | null; title?: string; user?: { [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; }; }>