Bulk Unsubscribe Profiles

//native

type Klaviyo = {

  apiKey: string;

};

/**

 * Bulk Unsubscribe Profiles

 * Unsubscribe one or more profiles to email marketing, SMS marketing, or both.

 */

export async function main(

  auth: Klaviyo,

  revision: string,

  body: {

    data: {

      type: "profile-subscription-bulk-delete-job";

      attributes: {

        profiles: {

          data: {

            type: "profile";

            attributes: {

              email?: string;

              phone_number?: string;

              subscriptions?: {

                email?: { marketing: { consent: "UNSUBSCRIBED" } };

                sms?: {

                  marketing?: { consent: "UNSUBSCRIBED" };

                  transactional?: { consent: "UNSUBSCRIBED" };

                };

              };

            };

          }[];

        };

      };

      relationships?: { list?: { data?: { type: "list"; id: string } } };

    };

  },

) {

  const url = new URL(

    `https://a.klaviyo.com/api/profile-subscription-bulk-delete-jobs`,

  );

  const response = await fetch(url, {

    method: "POST",

    headers: {

      revision: revision,

      "Accept": "application/vnd.api+json",

      "Content-Type": "application/vnd.api+json",

      Authorization: "Klaviyo-API-Key " + auth.apiKey,

    },

    body: JSON.stringify(body),

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}