Subscribe one or more profiles to email marketing, SMS marketing, or both. If the list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nTo add someone to a list without changing their subscription status, use Add Profile to List.\nThis API will remove any UNSUBSCRIBE
, SPAM_REPORT
or USER_SUPPRESSED
suppressions from the provided profiles. Learn more about suppressed profiles in this document.\nMaximum number of profile can be submitted for subscription: 100
Rate limits:
Burst: 75/s
Steady: 700/m
\n\nScopes:\nList Write
\nProfiles Write
\nSubscriptions Write
type: object
properties:
parameters:
type: object
properties:
revision:
type: string
default: '2023-02-22'
description: 'API endpoint revision (format: YYYY-MM-DD[.suffix])'
required:
- revision
title: Parameters
data:
type: object
required:
- data
properties:
data:
type: object
required:
- type
- attributes
properties:
type:
type: string
enum:
- profile-subscription-bulk-create-job
attributes:
type: object
required:
- list_id
- subscriptions
properties:
list_id:
type: string
example: Y6nRLr
description: The list to add the newly subscribed profiles to
custom_source:
type: string
example: Marketing Event
description: >-
A custom method detail or source to store on the consent
records.
subscriptions:
type: array
description: One or more subscriptions to be created.
items:
type: object
properties:
channels:
type: object
properties:
email:
type: array
example:
- MARKETING
description: >-
The communication types to subscribe to on the
\"EMAIL\" Channel. Currently supports \"MARKETING\".
items:
type: string
enum:
- MARKETING
description: >-
The communication types supported by email
subscriptions.
sms:
type: array
example:
- MARKETING
description: >-
The communication types to subscribe to on the
\"SMS\" Channel. Currently supports \"MARKETING\".
items:
type: string
enum:
- MARKETING
description: >-
The communication types supported by SMS
subscriptions.
email:
type: string
example:
[email protected]
description: >-
The email address to subscribe or to set on the profile
if `channels` is specified and the email channel is
omitted.
phone_number:
type: string
example: '+15005550006'
description: >-
The phone number to subscribe or to set on the profile
if `channels` is specified and the SMS channel is
omitted.
profile_id:
type: string
example: 01GDDKASAP8TKDDA2GRZDSVP4H
description: >-
The ID of the profile to subscribe. If provided, this
will be used to perform the lookup.
title: Data