HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Unsubscribe Profiles

Unsubscribe one or more profiles to email marketing, SMS marketing, or both.
To remove someone from a list without changing their subscription status, use Remove Profile from List.
Maximum number of profile can be submitted for unsubscription: 100

Rate limits:
Burst: 75/s
Steady: 700/m

Scopes:
List Write
Profiles Write
Subscriptions Write

Body Params

Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list. Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.

object
required
string
required
object
required
string
Defaults to Y6nRLr

Optional, the list to remove the profiles from

array of strings
Defaults to ["matt-kemp@klaviyo-demo.com", "sarah.mason@klaviyo-demo.com"

The emails to unsubscribe if any.

emails
array of strings
Defaults to ["+15005550006","+15005550007"]

The phone numbers to unsubscribe if any.

phone_numbers
Headers
string
required
Defaults to 2023-01-24

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Language
Credentials